feat(parser): add commonjs options (#11744)

* feat(parser): add `suppressCommonjsExports` options

* prefer common

Author: fi3ework

crates/node_binding/napi-binding.d.ts

@@ -2285,6 +2285,14 @@ export interface RawIntegrityItem {
   integrity: string
 }
 
+export declare enum RawJavascriptParserCommonjsExports {
+  SkipInEsm = 'skipInEsm'
+}
+
+export interface RawJavascriptParserCommonjsOptions {
+  exports?: boolean | 'skipInEsm'
+}
+
 export interface RawJavascriptParserOptions {
   dynamicImportMode?: string
   dynamicImportPreload?: string
@@ -2317,27 +2325,28 @@ export interface RawJavascriptParserOptions {
    * @experimental
    */
   requireResolve?: boolean
-  /**
-   * This option is experimental in Rspack only and subject to change or be removed anytime.
-   * @experimental
-   */
-  importDynamic?: boolean
-  commonjsMagicComments?: boolean
-  /**
-   * This option is experimental in Rspack only and subject to change or be removed anytime.
-   * @experimental
-   */
-  inlineConst?: boolean
-  /**
-   * This option is experimental in Rspack only and subject to change or be removed anytime.
-   * @experimental
-   */
-  typeReexportsPresence?: string
-  /**
-   * This option is experimental in Rspack only and subject to change or be removed anytime.
-   * @experimental
-   */
-  jsx?: boolean
+commonjs?: boolean | { exports?: boolean | 'skipInEsm' }
+/**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+importDynamic?: boolean
+commonjsMagicComments?: boolean
+/**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+inlineConst?: boolean
+/**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+typeReexportsPresence?: string
+/**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+jsx?: boolean
 }
 
 export interface RawJsonGeneratorOptions {

crates/node_binding/rspack.wasi-browser.js

@@ -115,6 +115,7 @@ export const JsRspackSeverity = __napiModule.exports.JsRspackSeverity
 export const loadBrowserslist = __napiModule.exports.loadBrowserslist
 export const minify = __napiModule.exports.minify
 export const minifySync = __napiModule.exports.minifySync
+export const RawJavascriptParserCommonjsExports = __napiModule.exports.RawJavascriptParserCommonjsExports
 export const RawRuleSetConditionType = __napiModule.exports.RawRuleSetConditionType
 export const registerGlobalTrace = __napiModule.exports.registerGlobalTrace
 export const RegisterJsTapKind = __napiModule.exports.RegisterJsTapKind

crates/node_binding/rspack.wasi.cjs

@@ -160,6 +160,7 @@ module.exports.JsRspackSeverity = __napiModule.exports.JsRspackSeverity
 module.exports.loadBrowserslist = __napiModule.exports.loadBrowserslist
 module.exports.minify = __napiModule.exports.minify
 module.exports.minifySync = __napiModule.exports.minifySync
+module.exports.RawJavascriptParserCommonjsExports = __napiModule.exports.RawJavascriptParserCommonjsExports
 module.exports.RawRuleSetConditionType = __napiModule.exports.RawRuleSetConditionType
 module.exports.registerGlobalTrace = __napiModule.exports.registerGlobalTrace
 module.exports.RegisterJsTapKind = __napiModule.exports.RegisterJsTapKind

crates/rspack/src/builder/mod.rs

@@ -42,13 +42,14 @@ use rspack_core::{
   CssGeneratorOptions, CssModuleGeneratorOptions, CssModuleParserOptions, CssParserOptions,
   DynamicImportMode, EntryDescription, EntryOptions, EntryRuntime, Environment,
   ExperimentCacheOptions, Experiments, ExternalItem, ExternalType, Filename, GeneratorOptions,
-  GeneratorOptionsMap, JavascriptParserOptions, JavascriptParserOrder, JavascriptParserUrl,
-  JsonGeneratorOptions, JsonParserOptions, LibraryName, LibraryNonUmdObject, LibraryOptions,
-  LibraryType, MangleExportsOption, Mode, ModuleNoParseRules, ModuleOptions, ModuleRule,
-  ModuleRuleEffect, ModuleType, NodeDirnameOption, NodeFilenameOption, NodeGlobalOption,
-  NodeOption, Optimization, OutputOptions, ParseOption, ParserOptions, ParserOptionsMap, PathInfo,
-  PublicPath, Resolve, RspackFuture, RuleSetCondition, RuleSetLogicalConditions, SideEffectOption,
-  StatsOptions, TrustedTypes, UsedExportsOption, WasmLoading, WasmLoadingType,
+  GeneratorOptionsMap, JavascriptParserCommonjsExportsOption, JavascriptParserCommonjsOptions,
+  JavascriptParserOptions, JavascriptParserOrder, JavascriptParserUrl, JsonGeneratorOptions,
+  JsonParserOptions, LibraryName, LibraryNonUmdObject, LibraryOptions, LibraryType,
+  MangleExportsOption, Mode, ModuleNoParseRules, ModuleOptions, ModuleRule, ModuleRuleEffect,
+  ModuleType, NodeDirnameOption, NodeFilenameOption, NodeGlobalOption, NodeOption, Optimization,
+  OutputOptions, ParseOption, ParserOptions, ParserOptionsMap, PathInfo, PublicPath, Resolve,
+  RspackFuture, RuleSetCondition, RuleSetLogicalConditions, SideEffectOption, StatsOptions,
+  TrustedTypes, UsedExportsOption, WasmLoading, WasmLoadingType,
   incremental::{IncrementalOptions, IncrementalPasses},
 };
 use rspack_error::{Error, Result};
@@ -1713,6 +1714,9 @@ impl ModuleOptionsBuilder {
           require_as_expression: Some(true),
           require_dynamic: Some(true),
           require_resolve: Some(true),
+          commonjs: Some(JavascriptParserCommonjsOptions {
+            exports: JavascriptParserCommonjsExportsOption::Enable,
+          }),
           import_dynamic: Some(true),
           commonjs_magic_comments: Some(false),
           inline_const: Some(false),

crates/rspack/tests/snapshots/defaults__default_options.snap

@@ -1435,6 +1435,11 @@ CompilerOptions {
                             require_resolve: Some(
                                 true,
                             ),
+                            commonjs: Some(
+                                JavascriptParserCommonjsOptions {
+                                    exports: Enable,
+                                },
+                            ),
                             import_dynamic: Some(
                                 true,
                             ),

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

@@ -13,10 +13,11 @@ use rspack_core::{
   CssAutoGeneratorOptions, CssAutoParserOptions, CssGeneratorOptions, CssModuleGeneratorOptions,
   CssModuleParserOptions, CssParserOptions, DescriptionData, DynamicImportFetchPriority,
   DynamicImportMode, ExportPresenceMode, FuncUseCtx, GeneratorOptions, GeneratorOptionsMap,
-  JavascriptParserOptions, JavascriptParserOrder, JavascriptParserUrl, JsonGeneratorOptions,
-  JsonParserOptions, ModuleNoParseRule, ModuleNoParseRules, ModuleNoParseTestFn, ModuleOptions,
-  ModuleRule, ModuleRuleEffect, ModuleRuleEnforce, ModuleRuleUse, ModuleRuleUseLoader,
-  OverrideStrict, ParseOption, ParserOptions, ParserOptionsMap, TypeReexportPresenceMode,
+  JavascriptParserCommonjsExportsOption, JavascriptParserCommonjsOptions, JavascriptParserOptions,
+  JavascriptParserOrder, JavascriptParserUrl, JsonGeneratorOptions, JsonParserOptions,
+  ModuleNoParseRule, ModuleNoParseRules, ModuleNoParseTestFn, ModuleOptions, ModuleRule,
+  ModuleRuleEffect, ModuleRuleEnforce, ModuleRuleUse, ModuleRuleUseLoader, OverrideStrict,
+  ParseOption, ParserOptions, ParserOptionsMap, TypeReexportPresenceMode,
 };
 use rspack_error::error;
 use rspack_napi::threadsafe_function::ThreadsafeFunction;
@@ -288,6 +289,8 @@ pub struct RawJavascriptParserOptions {
   /// This option is experimental in Rspack only and subject to change or be removed anytime.
   /// @experimental
   pub require_resolve: Option<bool>,
+  #[napi(ts_type = "boolean | { exports?: boolean | 'skipInEsm' }")]
+  pub commonjs: Option<Either<bool, RawJavascriptParserCommonjsOptions>>,
   /// This option is experimental in Rspack only and subject to change or be removed anytime.
   /// @experimental
   pub import_dynamic: Option<bool>,
@@ -303,6 +306,20 @@ pub struct RawJavascriptParserOptions {
   pub jsx: Option<bool>,
 }
 
+#[napi(object)]
+#[derive(Debug)]
+pub struct RawJavascriptParserCommonjsOptions {
+  #[napi(ts_type = "boolean | 'skipInEsm'")]
+  pub exports: Option<Either<bool, RawJavascriptParserCommonjsExports>>,
+}
+
+#[napi(string_enum)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum RawJavascriptParserCommonjsExports {
+  #[napi(value = "skipInEsm")]
+  SkipInEsm,
+}
+
 impl From<RawJavascriptParserOptions> for JavascriptParserOptions {
   fn from(value: RawJavascriptParserOptions) -> Self {
     Self {
@@ -344,6 +361,23 @@ impl From<RawJavascriptParserOptions> for JavascriptParserOptions {
       require_as_expression: value.require_as_expression,
       require_dynamic: value.require_dynamic,
       require_resolve: value.require_resolve,
+      commonjs: value.commonjs.map(|commonjs| match commonjs {
+        Either::A(flag) => JavascriptParserCommonjsOptions {
+          exports: JavascriptParserCommonjsExportsOption::from(flag),
+        },
+        Either::B(options) => {
+          let exports = options
+            .exports
+            .map(|exports| match exports {
+              Either::A(flag) => JavascriptParserCommonjsExportsOption::from(flag),
+              Either::B(RawJavascriptParserCommonjsExports::SkipInEsm) => {
+                JavascriptParserCommonjsExportsOption::SkipInEsm
+              }
+            })
+            .unwrap_or(JavascriptParserCommonjsExportsOption::Enable);
+          JavascriptParserCommonjsOptions { exports }
+        }
+      }),
       import_dynamic: value.import_dynamic,
       commonjs_magic_comments: value.commonjs_magic_comments,
       inline_const: value.inline_const,

crates/rspack_core/src/options/module.rs

@@ -191,6 +191,26 @@ impl From<&str> for JavascriptParserOrder {
   }
 }
 
+#[cacheable]
+#[derive(Debug, Clone, Copy, MergeFrom, PartialEq, Eq)]
+pub enum JavascriptParserCommonjsExportsOption {
+  Enable,
+  Disable,
+  SkipInEsm,
+}
+
+impl From<bool> for JavascriptParserCommonjsExportsOption {
+  fn from(value: bool) -> Self {
+    if value { Self::Enable } else { Self::Disable }
+  }
+}
+
+#[cacheable]
+#[derive(Debug, Clone, MergeFrom)]
+pub struct JavascriptParserCommonjsOptions {
+  pub exports: JavascriptParserCommonjsExportsOption,
+}
+
 #[cacheable]
 #[derive(Debug, Clone, Copy, MergeFrom)]
 pub enum ExportPresenceMode {
@@ -281,6 +301,7 @@ pub struct JavascriptParserOptions {
   pub require_as_expression: Option<bool>,
   pub require_dynamic: Option<bool>,
   pub require_resolve: Option<bool>,
+  pub commonjs: Option<JavascriptParserCommonjsOptions>,
   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_exports_parse_plugin.rs

@@ -256,7 +256,19 @@ fn handle_access_export(
   Some(true)
 }
 
-pub struct CommonJsExportsParserPlugin;
+pub struct CommonJsExportsParserPlugin {
+  skip_in_esm: bool,
+}
+
+impl CommonJsExportsParserPlugin {
+  pub fn new(skip_in_esm: bool) -> Self {
+    Self { skip_in_esm }
+  }
+
+  fn should_skip_handler(&self, parser: &JavascriptParser) -> bool {
+    self.skip_in_esm && parser.is_esm
+  }
+}
 
 impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
   fn assign_member_chain(
@@ -266,6 +278,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     remaining: &[Atom],
     for_name: &str,
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if for_name == "exports" {
       // exports.x = y;
       return handle_assign_export(parser, assign_expr, remaining, ExportsBase::Exports);
@@ -292,6 +308,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     call_expr: &CallExpr,
     for_name: &str,
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if parser.is_esm {
       return None;
     }
@@ -352,6 +372,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     ident: &Ident,
     for_name: &str,
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if for_name == "module" {
       let decorator = if parser.is_esm {
         RuntimeGlobals::ESM_MODULE_DECORATOR
@@ -379,6 +403,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     parser: &mut JavascriptParser,
     expr: &swc_core::ecma::ast::ThisExpr,
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if parser.is_top_level_this() {
       // this
       return handle_access_export(parser, expr.span(), &[], ExportsBase::This, None);
@@ -392,6 +420,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     expr: &MemberExpr,
     for_name: &str,
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if for_name == "module.exports" {
       // module.exports
       return handle_access_export(parser, expr.span(), &[], ExportsBase::ModuleExports, None);
@@ -408,6 +440,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     _members_optionals: &[bool],
     _member_ranges: &[Span],
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if for_name == "exports" {
       // exports.a.b.c
       return handle_access_export(parser, expr.span(), members, ExportsBase::Exports, None);
@@ -441,6 +477,10 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
     _members_optionals: &[bool],
     _member_ranges: &[Span],
   ) -> Option<bool> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     if for_name == "exports" {
       // exports.a.b.c()
       return handle_access_export(
@@ -479,10 +519,14 @@ impl JavascriptParserPlugin for CommonJsExportsParserPlugin {
 
   fn evaluate_typeof<'a>(
     &self,
-    _parser: &mut JavascriptParser,
+    parser: &mut JavascriptParser,
     expr: &'a UnaryExpr,
     for_name: &str,
   ) -> Option<BasicEvaluatedExpression<'a>> {
+    if self.should_skip_handler(parser) {
+      return None;
+    }
+
     (for_name == "module" || for_name == "exports").then(|| {
       eval::evaluate_to_string(
         "object".to_string(),

crates/rspack_plugin_javascript/src/visitors/dependency/parser/mod.rs

@@ -12,8 +12,9 @@ pub use call_hooks_name::CallHooksName;
 use rspack_cacheable::{cacheable, with::AsPreset};
 use rspack_core::{
   AsyncDependenciesBlock, BoxDependency, BoxDependencyTemplate, BuildInfo, BuildMeta,
-  CompilerOptions, DependencyRange, FactoryMeta, JavascriptParserOptions, JavascriptParserUrl,
-  ModuleIdentifier, ModuleLayer, ModuleType, ParseMeta, ResourceData, TypeReexportPresenceMode,
+  CompilerOptions, DependencyRange, FactoryMeta, JavascriptParserCommonjsExportsOption,
+  JavascriptParserOptions, JavascriptParserUrl, ModuleIdentifier, ModuleLayer, ModuleType,
+  ParseMeta, ResourceData, TypeReexportPresenceMode,
 };
 use rspack_error::{Diagnostic, Result};
 use rspack_util::SpanExt;
@@ -346,7 +347,17 @@ impl<'parser> JavascriptParser<'parser> {
     if module_type.is_js_auto() || module_type.is_js_dynamic() {
       plugins.push(Box::new(parser_plugin::CommonJsImportsParserPlugin));
       plugins.push(Box::new(parser_plugin::CommonJsPlugin));
-      plugins.push(Box::new(parser_plugin::CommonJsExportsParserPlugin));
+      let commonjs_exports = javascript_options
+        .commonjs
+        .as_ref()
+        .map_or(JavascriptParserCommonjsExportsOption::Enable, |commonjs| {
+          commonjs.exports
+        });
+      if commonjs_exports != JavascriptParserCommonjsExportsOption::Disable {
+        plugins.push(Box::new(parser_plugin::CommonJsExportsParserPlugin::new(
+          commonjs_exports == JavascriptParserCommonjsExportsOption::SkipInEsm,
+        )));
+      }
       if compiler_options.node.is_some() {
         plugins.push(Box::new(parser_plugin::NodeStuffPlugin));
       }