chore: rename to import_mode

Author: SoonIter

crates/node_binding/binding.d.ts

@@ -1143,7 +1143,7 @@ export interface RawAssetGeneratorOptions {
   outputPath?: JsFilename
   publicPath?: "auto" | JsFilename
   dataUrl?: RawAssetGeneratorDataUrlOptions | ((source: Buffer, context: RawAssetGeneratorDataUrlFnCtx) => string)
-  experimentalPreserveImport?: boolean
+  importMode?: "url" | "preserve"
 }
 
 export interface RawAssetInlineGeneratorOptions {
@@ -1168,7 +1168,7 @@ export interface RawAssetResourceGeneratorOptions {
   filename?: JsFilename
   outputPath?: JsFilename
   publicPath?: "auto" | JsFilename
-  experimentalPreserveImport?: boolean
+  importMode?: "url" | "preserve"
 }
 
 export interface RawBannerPluginOptions {

crates/rspack_binding_values/src/raw_options/raw_module/mod.rs

@@ -542,7 +542,8 @@ pub struct RawAssetGeneratorOptions {
   )]
   pub data_url: Option<RawAssetGeneratorDataUrl>,
 
-  pub experimental_preserve_import: Option<bool>,
+  #[napi(ts_type = r#""url" | "preserve""#)]
+  pub import_mode: Option<String>,
 }
 
 impl From<RawAssetGeneratorOptions> for AssetGeneratorOptions {
@@ -555,7 +556,7 @@ impl From<RawAssetGeneratorOptions> for AssetGeneratorOptions {
       data_url: value
         .data_url
         .map(|i| RawAssetGeneratorDataUrlWrapper(i).into()),
-      experimental_preserve_import: value.experimental_preserve_import,
+      import_mode: value.import_mode.map(|n| n.into()),
     }
   }
 }
@@ -588,8 +589,8 @@ pub struct RawAssetResourceGeneratorOptions {
   pub output_path: Option<JsFilename>,
   #[napi(ts_type = "\"auto\" | JsFilename")]
   pub public_path: Option<JsFilename>,
-
-  pub experimental_preserve_import: Option<bool>,
+  #[napi(ts_type = r#""url" | "preserve""#)]
+  pub import_mode: Option<String>,
 }
 
 impl From<RawAssetResourceGeneratorOptions> for AssetResourceGeneratorOptions {
@@ -599,7 +600,7 @@ impl From<RawAssetResourceGeneratorOptions> for AssetResourceGeneratorOptions {
       filename: value.filename.map(|i| i.into()),
       output_path: value.output_path.map(|i| i.into()),
       public_path: value.public_path.map(|i| i.into()),
-      experimental_preserve_import: value.experimental_preserve_import,
+      import_mode: value.import_mode.map(|i| i.into()),
     }
   }
 }

crates/rspack_core/src/options/module.rs

@@ -472,14 +472,53 @@ impl From<AssetGeneratorOptions> for AssetInlineGeneratorOptions {
   }
 }
 
+#[cacheable]
+#[derive(Debug, Clone, Copy, MergeFrom)]
+struct AssetGeneratorImportModeFlags(u8);
+bitflags! {
+  impl AssetGeneratorImportModeFlags: u8 {
+    const URL = 1 << 0;
+    const PRESERVE = 1 << 1;
+  }
+}
+
+#[cacheable]
+#[derive(Debug, Clone, Copy, MergeFrom)]
+pub struct AssetGeneratorImportMode(AssetGeneratorImportModeFlags);
+
+impl AssetGeneratorImportMode {
+  pub fn is_url(&self) -> bool {
+    self.0.contains(AssetGeneratorImportModeFlags::URL)
+  }
+  pub fn is_preserve(&self) -> bool {
+    self.0.contains(AssetGeneratorImportModeFlags::PRESERVE)
+  }
+}
+
+impl From<String> for AssetGeneratorImportMode {
+  fn from(s: String) -> Self {
+    match s.as_str() {
+      "url" => Self(AssetGeneratorImportModeFlags::URL),
+      "preserve" => Self(AssetGeneratorImportModeFlags::PRESERVE),
+      _ => unreachable!("AssetGeneratorImportMode error"),
+    }
+  }
+}
+
+impl Default for AssetGeneratorImportMode {
+  fn default() -> Self {
+    Self(AssetGeneratorImportModeFlags::URL)
+  }
+}
+
 #[cacheable]
 #[derive(Debug, Clone, MergeFrom)]
 pub struct AssetResourceGeneratorOptions {
   pub emit: Option<bool>,
   pub filename: Option<Filename>,
   pub output_path: Option<Filename>,
   pub public_path: Option<PublicPath>,
-  pub experimental_preserve_import: Option<bool>,
+  pub import_mode: Option<AssetGeneratorImportMode>,
 }
 
 impl From<AssetGeneratorOptions> for AssetResourceGeneratorOptions {
@@ -489,7 +528,7 @@ impl From<AssetGeneratorOptions> for AssetResourceGeneratorOptions {
       filename: value.filename,
       output_path: value.output_path,
       public_path: value.public_path,
-      experimental_preserve_import: value.experimental_preserve_import,
+      import_mode: value.import_mode,
     }
   }
 }
@@ -502,7 +541,7 @@ pub struct AssetGeneratorOptions {
   pub output_path: Option<Filename>,
   pub public_path: Option<PublicPath>,
   pub data_url: Option<AssetGeneratorDataUrl>,
-  pub experimental_preserve_import: Option<bool>,
+  pub import_mode: Option<AssetGeneratorImportMode>,
 }
 
 pub struct AssetGeneratorDataUrlFnCtx<'a> {

crates/rspack_plugin_asset/src/lib.rs

@@ -8,13 +8,13 @@ use rayon::prelude::*;
 use rspack_cacheable::{cacheable, cacheable_dyn};
 use rspack_core::{
   rspack_sources::{BoxSource, RawBufferSource, RawStringSource, SourceExt},
-  AssetGeneratorDataUrl, AssetGeneratorDataUrlFnCtx, AssetInfo, AssetParserDataUrl,
-  BuildMetaDefaultObject, BuildMetaExportsType, ChunkGraph, ChunkUkey, CodeGenerationDataAssetInfo,
-  CodeGenerationDataFilename, CodeGenerationDataUrl, CodeGenerationPublicPathAutoReplace,
-  Compilation, CompilationRenderManifest, CompilerOptions, Filename, GenerateContext,
-  GeneratorOptions, LocalFilenameFn, Module, ModuleGraph, NormalModule, ParseContext,
-  ParserAndGenerator, PathData, Plugin, PublicPath, RenderManifestEntry, ResourceData,
-  RuntimeGlobals, RuntimeSpec, SourceType, NAMESPACE_OBJECT_EXPORT,
+  AssetGeneratorDataUrl, AssetGeneratorDataUrlFnCtx, AssetGeneratorImportMode, AssetInfo,
+  AssetParserDataUrl, BuildMetaDefaultObject, BuildMetaExportsType, ChunkGraph, ChunkUkey,
+  CodeGenerationDataAssetInfo, CodeGenerationDataFilename, CodeGenerationDataUrl,
+  CodeGenerationPublicPathAutoReplace, Compilation, CompilationRenderManifest, CompilerOptions,
+  Filename, GenerateContext, GeneratorOptions, LocalFilenameFn, Module, ModuleGraph, NormalModule,
+  ParseContext, ParserAndGenerator, PathData, Plugin, PublicPath, RenderManifestEntry,
+  ResourceData, RuntimeGlobals, RuntimeSpec, SourceType, NAMESPACE_OBJECT_EXPORT,
 };
 use rspack_error::{error, Diagnostic, IntoTWithDiagnosticArray, Result};
 use rspack_hash::{RspackHash, RspackHashDigest};
@@ -305,21 +305,21 @@ impl AssetParserAndGenerator {
     Ok((public_path, info))
   }
 
-  fn get_experimental_lib_options(
+  fn get_import_mode(
     &self,
     module_generator_options: Option<&GeneratorOptions>,
-  ) -> Result<bool> {
-    let experimental_preserve_import = module_generator_options
+  ) -> Result<AssetGeneratorImportMode> {
+    let import_mode = module_generator_options
       .and_then(|x| x.get_asset())
-      .and_then(|x| x.experimental_preserve_import)
+      .and_then(|x| x.import_mode)
       .or_else(|| {
         module_generator_options
           .and_then(|x| x.get_asset_resource())
-          .and_then(|x| x.experimental_preserve_import)
+          .and_then(|x| x.import_mode)
       })
-      .unwrap_or(false);
+      .unwrap_or_default();
 
-    Ok(experimental_preserve_import)
+    Ok(import_mode)
   }
 }
 
@@ -453,8 +453,7 @@ impl ParserAndGenerator for AssetParserAndGenerator {
       .expect("module should be a NormalModule in AssetParserAndGenerator");
     let module_generator_options = normal_module.get_generator_options();
 
-    let experimental_preserve_import =
-      self.get_experimental_lib_options(module_generator_options)?;
+    let import_mode = self.get_import_mode(module_generator_options)?;
 
     let result = match generate_context.requested_source_type {
       SourceType::JavaScript => {
@@ -500,7 +499,7 @@ impl ParserAndGenerator for AssetParserAndGenerator {
             true,
           )?;
 
-          let asset_path = if experimental_preserve_import {
+          let asset_path = if import_mode.is_preserve() {
             generate_context
               .data
               .insert(CodeGenerationPublicPathAutoReplace(true));
@@ -560,7 +559,7 @@ impl ParserAndGenerator for AssetParserAndGenerator {
           unreachable!()
         };
 
-        if experimental_preserve_import && parsed_asset_config.is_resource() {
+        if import_mode.is_preserve() && parsed_asset_config.is_resource() {
           let is_module = compilation.options.output.module;
           if let Some(ref mut scope) = generate_context.concatenation_scope {
             scope.register_namespace_export(NAMESPACE_OBJECT_EXPORT);

packages/rspack-test-tools/tests/configCases/asset/preserve-import/rspack.config.js

@@ -12,7 +12,7 @@ module.exports = {
 				test: /\.png$/,
 				type: "asset/resource",
 				generator: {
-					experimentalPreserveImport: true
+					importMode: "preserve"
 				}
 			}
 		]

packages/rspack-test-tools/tests/configCases/library/modern-module-asset-entry/rspack.config.js

@@ -24,7 +24,7 @@ module.exports = {
 				type: "asset/resource",
 				generator: {
 					filename: 'static/img/[name].png',
-					experimentalPreserveImport: true
+					importMode: "preserve"
 				}
 			}
 		]
@@ -46,7 +46,7 @@ module.exports = {
 						const js = list.find(item => item.endsWith("js"));
 						const jsContent = assets[js].source().toString();
 
-						const preseveImport = /import img_namespaceObject from ['"]\.\/static\/img\/img\.png['"]/.test(jsContent);
+						const preseveImport = /import\simg_namespaceObject\sfrom ['"]\.\/static\/img\/img\.png['"]/.test(jsContent);
 						assert(preseveImport);
 						const hasExports = /export\s{\simg_namespaceObject\sas\sdefault\s}/.test(jsContent);
 						assert(hasExports);