feat: support resolve imports fields options

Author: ahabhgk

crates/node_binding/binding.d.ts

@@ -1217,6 +1217,7 @@ export interface RawResolveOptions {
   aliasFields?: Array<string>
   restrictions?: Array<string>
   roots?: Array<string>
+  importsFields?: Array<string>
 }
 
 export interface RawResolveTsconfigOptions {

crates/rspack_binding_options/src/options/raw_resolve.rs

@@ -49,6 +49,7 @@ pub struct RawResolveOptions {
   pub alias_fields: Option<Vec<String>>,
   pub restrictions: Option<Vec<String>>,
   pub roots: Option<Vec<String>>,
+  pub imports_fields: Option<Vec<String>>,
 }
 
 fn normalize_alias(alias: Option<Vec<RawAliasOptionItem>>) -> rspack_error::Result<Option<Alias>> {
@@ -120,6 +121,9 @@ impl TryFrom<RawResolveOptions> for Resolve {
       .map(|v| v.into_iter().map(|s| vec![s]).collect());
     let restrictions = value.restrictions;
     let roots = value.roots;
+    let imports_fields = value
+      .imports_fields
+      .map(|v| v.into_iter().map(|s| vec![s]).collect());
     Ok(Resolve {
       modules,
       prefer_relative,
@@ -139,6 +143,7 @@ impl TryFrom<RawResolveOptions> for Resolve {
       alias_fields,
       restrictions,
       roots,
+      imports_fields,
     })
   }
 }

crates/rspack_core/src/options/resolve/clever_merge.rs

@@ -3,8 +3,8 @@ use hashlink::LinkedHashMap;
 use super::value_type::{GetValueType, ValueType};
 use super::{
   Alias, AliasFields, ConditionNames, ExportsField, ExtensionAlias, Extensions, Fallback,
-  FullySpecified, MainFields, MainFiles, Modules, PreferAbsolute, PreferRelative, Restrictions,
-  Roots, Symlink, TsconfigOptions,
+  FullySpecified, ImportsFields, MainFields, MainFiles, Modules, PreferAbsolute, PreferRelative,
+  Restrictions, Roots, Symlink, TsconfigOptions,
 };
 use super::{ByDependency, DependencyCategoryStr, Resolve};
 
@@ -64,6 +64,7 @@ struct ResolveWithEntry {
   alias_fields: Entry<AliasFields>,
   restrictions: Entry<Restrictions>,
   roots: Entry<Roots>,
+  imports_fields: Entry<ImportsFields>,
 }
 
 fn parse_resolve(resolve: Resolve) -> ResolveWithEntry {
@@ -93,6 +94,7 @@ fn parse_resolve(resolve: Resolve) -> ResolveWithEntry {
     alias_fields: entry!(alias_fields),
     restrictions: entry!(restrictions),
     roots: entry!(roots),
+    imports_fields: entry!(imports_fields),
   };
   let Some(by_dependency) = resolve.by_dependency else {
     return res;
@@ -313,6 +315,7 @@ fn _merge_resolve(first: Resolve, second: Resolve) -> Resolve {
     alias_fields: merge!(alias_fields, ValueType::Other, |_| false, |_, b| b),
     restrictions: merge!(restrictions, ValueType::Other, |_| false, |_, b| b),
     roots: merge!(roots, ValueType::Other, |_| false, |_, b| b),
+    imports_fields: merge!(imports_fields, ValueType::Other, |_| false, |_, b| b),
   };
 
   let mut by_dependency: LinkedHashMap<DependencyCategoryStr, Resolve> = LinkedHashMap::new();
@@ -376,6 +379,7 @@ fn _merge_resolve(first: Resolve, second: Resolve) -> Resolve {
   to_resolve!(alias_fields);
   to_resolve!(restrictions);
   to_resolve!(roots);
+  to_resolve!(imports_fields);
 
   let by_dependency = if by_dependency.iter().all(|(_, by_value)| is_empty(by_value)) {
     None
@@ -402,6 +406,7 @@ fn _merge_resolve(first: Resolve, second: Resolve) -> Resolve {
     alias_fields: result_entry.alias_fields.base,
     restrictions: result_entry.restrictions.base,
     roots: result_entry.roots.base,
+    imports_fields: result_entry.imports_fields.base,
   }
 }
 

crates/rspack_core/src/options/resolve/mod.rs

@@ -25,6 +25,7 @@ pub(super) type ExtensionAlias = Vec<(String, Vec<String>)>;
 pub(super) type Modules = Vec<String>;
 pub(super) type Roots = Vec<String>;
 pub(super) type Restrictions = Vec<String>;
+pub(super) type ImportsFields = Vec<Vec<String>>;
 
 #[derive(Debug, Clone, Default, Hash, PartialEq, Eq)]
 pub struct Resolve {
@@ -73,7 +74,9 @@ pub struct Resolve {
   /// A list of directories where requests of server-relative URLs (starting with '/') are resolved
   pub roots: Option<Roots>,
   /// A list of resolve restrictions to restrict the paths that a request can be resolved on.
-  pub restrictions: Option<Roots>,
+  pub restrictions: Option<Restrictions>,
+  /// Field names from the description file (usually package.json) which are used to provide internal request of a package (requests starting with # are considered as internal).
+  pub imports_fields: Option<ImportsFields>,
   /// Configure resolve options by the type of module request.
   pub by_dependency: Option<ByDependency>,
 }

crates/rspack_core/src/resolver/resolver_impl.rs

@@ -259,6 +259,9 @@ fn to_oxc_resolver_options(
     .into_iter()
     .map(PathBuf::from)
     .collect();
+  let imports_fields = options
+    .imports_fields
+    .unwrap_or_else(|| vec![vec!["imports".to_string()]]);
   oxc_resolver::ResolveOptions {
     fallback,
     modules,
@@ -281,7 +284,7 @@ fn to_oxc_resolver_options(
     restrictions,
     roots,
     builtin_modules: false,
-    imports_fields: vec![vec!["imports".to_string()]],
+    imports_fields,
   }
 }
 

packages/rspack-test-tools/tests/configCases/resolve/imports-fields/index.js

@@ -0,0 +1,8 @@
+import d1 from "./pkg.mjs";
+import d2 from "#internal";
+import d3 from "#internal2"
+
+it("imports field to resolve to the same", () => {
+	expect(d2).toBe(d1);
+	expect(d3).toBe(d1);
+});

packages/rspack-test-tools/tests/configCases/resolve/imports-fields/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "pkg",
+  "hash-start": {
+    "#internal": "./pkg.mjs"
+  },
+  "imports": {
+    "#internal": "./index.js",
+    "#internal2": "./pkg.mjs"
+  }
+}

packages/rspack-test-tools/tests/configCases/resolve/imports-fields/pkg.mjs

@@ -0,0 +1 @@
+export default 'pkg';

packages/rspack-test-tools/tests/configCases/resolve/imports-fields/webpack.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+	entry: "./index.js",
+	resolve: {
+		importsFields: ["hash-start", "..."]
+	}
+};

packages/rspack/etc/api.md

@@ -736,6 +736,7 @@ const baseResolveOptions: z.ZodObject<{
     aliasFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     restrictions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     roots: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    importsFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strict", z.ZodTypeAny, {
     alias?: Record<string, string | false | (string | false)[]> | undefined;
     browserField?: boolean | undefined;
@@ -759,6 +760,7 @@ const baseResolveOptions: z.ZodObject<{
     aliasFields?: string[] | undefined;
     restrictions?: string[] | undefined;
     roots?: string[] | undefined;
+    importsFields?: string[] | undefined;
 }, {
     alias?: Record<string, string | false | (string | false)[]> | undefined;
     browserField?: boolean | undefined;
@@ -782,6 +784,7 @@ const baseResolveOptions: z.ZodObject<{
     aliasFields?: string[] | undefined;
     restrictions?: string[] | undefined;
     roots?: string[] | undefined;
+    importsFields?: string[] | undefined;
 }>;
 
 // @public (undocumented)