feat!: use 'commonjs-import' as CJS external type by default

Author: fi3ework

package.json

@@ -64,6 +64,7 @@
   },
   "pnpm": {
     "overrides": {
+      "@rspack/core": "npm:@rspack/[email protected]",
       "zx>@types/node": "-"
     }
   }

packages/core/src/config.ts

@@ -683,7 +683,7 @@ const composeExternalsConfig = (
 
   const externalsTypeMap = {
     esm: 'module-import',
-    cjs: 'commonjs',
+    cjs: 'commonjs-import',
     umd: 'umd',
     // If use 'var', when projects import an external package like '@pkg', this will cause a syntax error such as 'var pkg = @pkg'.
     // If use 'umd', the judgement conditions may be affected by other packages that define variables like 'define'.

packages/core/tests/__snapshots__/config.test.ts.snap

@@ -396,7 +396,7 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config 1
             },
           },
           {
-            "externalsType": "commonjs",
+            "externalsType": "commonjs-import",
             "module": {
               "parser": {
                 "javascript": {

pnpm-lock.yaml

@@ -66,3 +66,11 @@ test('should get warn when use require in ESM', async () => {
 
   restore();
 });
+
+test('require ESM from CJS', async () => {
+  const fixturePath = join(__dirname, 'node');
+  const { entryFiles } = await buildAndGetResults({ fixturePath });
+  const baz = (await import(entryFiles.cjs)).baz;
+  const bazValue = await baz();
+  expect(bazValue).toBe('baz');
+});

tests/integration/externals/index.test.ts

@@ -18,6 +18,7 @@ export default defineConfig({
     },
   },
   output: {
-    externals: { react: 'react', bar: 'bar' },
+    externals: { react: 'react', bar: 'bar', './baz.mjs': './baz.mjs' },
+    copy: [{ from: './src/baz.mjs' }],
   },
 });

tests/integration/externals/node/rslib.config.ts

@@ -0,0 +1 @@
+export const baz = 'baz';

tests/integration/externals/node/src/baz.mjs

@@ -2,11 +2,20 @@ import fs from 'fs'; // handle bare node built-in modules
 import assert from 'node:assert'; // handle node built-in modules with node: protocol
 import React from 'react'; // works with the externals option in rslib.config.ts
 
-export const foo = () => {
+export const foo = async () => {
   assert(fs, 'fs exists');
+  const fooModule = require('foo'); // ESM: specified externals type
+  fooModule();
+};
+
+export const bar = async () => {
   assert(React.version);
-  const foo = require('foo'); // ESM: specified externals type
-  const bar = require('bar'); // ESM: fallback to "module" when not specify externals type
-  foo();
-  bar();
+  const barModule = require('bar'); // ESM: fallback to "module" when not specify externals type
+  barModule();
+};
+
+export const baz = async () => {
+  // @ts-ignore
+  const bazModule = await import('./baz.mjs'); // should be kept dynamic import by default
+  return bazModule.baz;
 };