feat: support webpackIgnore in commonjs require (#11704)

* feat: support webpackIgnore in commonjs require

* feat: gate commonjs magic comment support

* chore: rebuild napi bindings

* fix: treat ignored commonjs require as handled

* fix: collapse webpackIgnore pattern guards

* refactor: remove commonjsMagicComments in default config

* fix: comments

Author: stormslowly

crates/node_binding/napi-binding.d.ts

@@ -2322,6 +2322,7 @@ export interface RawJavascriptParserOptions {
    * @experimental
    */
   importDynamic?: boolean
+  commonjsMagicComments?: boolean
   /**
    * This option is experimental in Rspack only and subject to change or be removed anytime.
    * @experimental

crates/rspack/src/builder/mod.rs

@@ -1714,6 +1714,7 @@ impl ModuleOptionsBuilder {
           require_dynamic: Some(true),
           require_resolve: Some(true),
           import_dynamic: Some(true),
+          commonjs_magic_comments: Some(false),
           inline_const: Some(false),
           ..Default::default()
         }),

crates/rspack/tests/snapshots/defaults__default_options.snap

@@ -1438,6 +1438,9 @@ CompilerOptions {
                             import_dynamic: Some(
                                 true,
                             ),
+                            commonjs_magic_comments: Some(
+                                false,
+                            ),
                             inline_const: Some(
                                 false,
                             ),

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

@@ -291,6 +291,7 @@ pub struct RawJavascriptParserOptions {
   /// This option is experimental in Rspack only and subject to change or be removed anytime.
   /// @experimental
   pub import_dynamic: Option<bool>,
+  pub commonjs_magic_comments: Option<bool>,
   /// This option is experimental in Rspack only and subject to change or be removed anytime.
   /// @experimental
   pub inline_const: Option<bool>,
@@ -341,6 +342,7 @@ impl From<RawJavascriptParserOptions> for JavascriptParserOptions {
       require_dynamic: value.require_dynamic,
       require_resolve: value.require_resolve,
       import_dynamic: value.import_dynamic,
+      commonjs_magic_comments: value.commonjs_magic_comments,
       inline_const: value.inline_const,
     }
   }

crates/rspack_core/src/options/module.rs

@@ -282,6 +282,7 @@ pub struct JavascriptParserOptions {
   pub require_dynamic: Option<bool>,
   pub require_resolve: Option<bool>,
   pub import_dynamic: Option<bool>,
+  pub commonjs_magic_comments: Option<bool>,
   pub inline_const: Option<bool>,
 }
 

crates/rspack_plugin_javascript/src/parser_plugin/common_js_imports_parse_plugin.rs

@@ -21,6 +21,7 @@ use crate::{
   visitors::{
     JavascriptParser, context_reg_exp, create_context_dependency, create_traceable_error, expr_name,
   },
+  webpack_comment::try_extract_webpack_magic_comment,
 };
 
 fn create_commonjs_require_context_dependency(
@@ -126,11 +127,38 @@ impl CallOrNewExpr<'_> {
 pub struct CommonJsImportsParserPlugin;
 
 impl CommonJsImportsParserPlugin {
+  fn has_webpack_ignore_comment(
+    parser: &mut JavascriptParser,
+    error_span: Span,
+    span: Span,
+  ) -> bool {
+    if !parser
+      .javascript_options
+      .commonjs_magic_comments
+      .unwrap_or(false)
+    {
+      return false;
+    }
+
+    try_extract_webpack_magic_comment(parser, error_span, span)
+      .get_webpack_ignore()
+      .unwrap_or_default()
+  }
+
   fn process_resolve(&self, parser: &mut JavascriptParser, call_expr: &CallExpr, weak: bool) {
     if call_expr.args.len() != 1 {
       return;
     }
 
+    if let ExprOrSpread {
+      spread: None,
+      expr: argument_expr,
+    } = &call_expr.args[0]
+      && Self::has_webpack_ignore_comment(parser, call_expr.span, argument_expr.span())
+    {
+      return;
+    }
+
     let argument_expr = &call_expr.args[0].expr;
     let param = parser.evaluate_expression(argument_expr);
     let require_resolve_header_dependency = Box::new(RequireResolveHeaderDependency::new(
@@ -196,6 +224,14 @@ impl CommonJsImportsParserPlugin {
       return None;
     }
     let arg = &call_expr.args[0];
+    if let ExprOrSpread {
+      spread: None,
+      expr: argument_expr,
+    } = arg
+      && Self::has_webpack_ignore_comment(parser, call_expr.span, argument_expr.span())
+    {
+      return None;
+    }
     let param = parser.evaluate_expression(&arg.expr);
     param.is_string().then(|| {
       CommonJsFullRequireDependency::new(
@@ -252,8 +288,16 @@ impl CommonJsImportsParserPlugin {
       return None;
     }
 
-    let argument_expr = &args[0].expr;
-    let param = parser.evaluate_expression(argument_expr);
+    if let ExprOrSpread {
+      spread: None,
+      expr: argument_expr,
+    } = &args[0]
+      && Self::has_webpack_ignore_comment(parser, expr.span(), argument_expr.span())
+    {
+      return Some(true);
+    }
+
+    let param = parser.evaluate_expression(&args[0].expr);
     if param.is_conditional() {
       let mut is_expression = false;
       for p in param.options() {

packages/rspack/etc/core.api.md

@@ -3377,6 +3377,7 @@ export type JavascriptParserOptions = {
     requireDynamic?: boolean;
     requireResolve?: boolean;
     importDynamic?: boolean;
+    commonjsMagicComments?: boolean;
     inlineConst?: boolean;
     typeReexportsPresence?: "no-tolerant" | "tolerant" | "tolerant-no-check";
 };

packages/rspack/src/config/adapter.ts

@@ -584,6 +584,7 @@ function getRawJavascriptParserOptions(
 		requireDynamic: parser.requireDynamic,
 		requireResolve: parser.requireResolve,
 		importDynamic: parser.importDynamic,
+		commonjsMagicComments: parser.commonjsMagicComments,
 		inlineConst: parser.inlineConst,
 		typeReexportsPresence: parser.typeReexportsPresence
 	};

packages/rspack/src/config/types.ts

@@ -1108,6 +1108,11 @@ export type JavascriptParserOptions = {
 	// TODO: add docs
 	importDynamic?: boolean;
 
+	/**
+	 * Enable magic comments for CommonJS require() expressions.
+	 */
+	commonjsMagicComments?: boolean;
+
 	/** Inline const values in this module */
 	inlineConst?: boolean;
 

packages/rspack/src/schema/config.ts

@@ -651,6 +651,7 @@ export const getRspackOptionsSchema = memoize(() => {
 	const requireDynamic = z.boolean();
 	const requireResolve = z.boolean();
 	const importDynamic = z.boolean();
+	const commonjsMagicComments = z.boolean();
 	const inlineConst = z.boolean();
 	const typeReexportsPresence = z.enum([
 		"no-tolerant",
@@ -676,6 +677,7 @@ export const getRspackOptionsSchema = memoize(() => {
 			strictExportPresence: strictExportPresence,
 			worker: worker,
 			overrideStrict: overrideStrict,
+			commonjsMagicComments: commonjsMagicComments,
 			// #region Not available in webpack yet.
 			requireAsExpression: requireAsExpression,
 			requireDynamic: requireDynamic,