chore: doc the import_mode

Author: SoonIter

packages/rspack/src/config/types.ts

@@ -1149,8 +1149,9 @@ export type AssetInlineGeneratorOptions = {
 export type AssetModuleOutputPath = Filename;
 
 /**
- * If "url", generate url for asset based on `publicPath`
- * If "preserve", preserve import statement from generated asset
+ * If "url", a URL pointing to the asset will be generated based on publicPath.
+ * If "preserve", preserve import/require statement from generated asset.
+ * Only for modules with module type 'asset' or 'asset/resource'.
  * @default "url"
  */
 export type AssetModuleImportMode = "url" | "preserve";

website/docs/en/config/module.mdx

@@ -486,6 +486,44 @@ When set to 'base64', module source will be encoded using Base64 algorithm. Sett
 
 A mimetype for data URI. Resolves from module resource extension by default. Only for modules with module type `'asset'` or `'asset/inline'`.
 
+#### module.generator.asset.importMode
+
+- **Type:** `'url' | 'preserve'`
+- **Default:** `'url'`
+
+If `"url"`, a URL pointing to the asset will be generated based on [publicPath](#modulegeneratorassetpublicPath).
+If `"preserve"`, preserve import/require statement from generated asset.
+
+Only for modules with module type `'asset'` or `'asset/resource'`.
+
+- `'asset'`:
+
+```js title=rspack.config.js
+module.exports = {
+  module: {
+    generator: {
+      asset: {
+        importMode: 'preserve',
+      },
+    },
+  },
+};
+```
+
+- `'asset/resource'`:
+
+```js title=rspack.config.js
+module.exports = {
+  module: {
+    generator: {
+      'asset/resource': {
+        importMode: 'preserve',
+      },
+    },
+  },
+};
+```
+
 #### module.generator.asset.filename
 
 - **Type:** `string | ((pathData: PathData, assetInfo?: AssetInfo) => string)`

website/docs/zh/config/module.mdx

@@ -486,6 +486,44 @@ module.exports = {
 
 dataUrl 的 MIME 类型，默认从模块资源扩展名解析。仅对模块类型为 `'asset/inline'` 的模块生效。
 
+#### module.generator.asset.importMode
+
+- **类型：** `'url' | 'preserve'`
+- **默认值：** `'url'`
+
+如果为 `"url"`，将基于 [publicPath](#modulegeneratorassetpublicPath) 生成指向 asset 的 URL。
+如果为 `"preserve"`，将保留指向生成的 asset 的 import 或 require 语句。
+
+仅对模块类型为 `'asset'` 和 `'asset/resource'` 的模块生效。
+
+- `'asset'`:
+
+```js title=rspack.config.js
+module.exports = {
+  module: {
+    generator: {
+      asset: {
+        importMode: 'preserve',
+      },
+    },
+  },
+};
+```
+
+- `'asset/resource'`:
+
+```js title=rspack.config.js
+module.exports = {
+  module: {
+    generator: {
+      'asset/resource': {
+        importMode: 'preserve',
+      },
+    },
+  },
+};
+```
+
 #### module.generator.asset.filename
 
 - **类型：** `string | ((pathData: PathData, assetInfo?: AssetInfo) => string)`