fix!: remove transformImport false option (#3289)

web-infra-dev · Aug 27, 2024 · bee8d4c · bee8d4c
1 parent c8cb3eb
commit bee8d4c
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 279 deletions.
diff --git a/e2e/cases/source/plugin-import/foo/index.js b/e2e/cases/source/plugin-import/foo/index.js
@@ -0,0 +1 @@
+export const foo = 'test succeed';
diff --git a/e2e/cases/source/plugin-import/index.test.ts b/e2e/cases/source/plugin-import/index.test.ts
@@ -28,6 +28,24 @@ test('should import with template config', async () => {
   expect(files[entry]).toContain('transformImport test succeed');
 });
 
+test('should not transformImport by default', async () => {
+  copyPkgToNodeModules();
+
+  const rsbuild = await build({
+    cwd: __dirname,
+    rsbuildConfig: {
+      performance: {
+        chunkSplit: {
+          strategy: 'all-in-one',
+        },
+      },
+    },
+  });
+  const files = await rsbuild.unwrapOutputJSON(false);
+  const entry = findEntry(files);
+  expect(files[entry]).toContain('test succeed');
+});
+
 for (const c of cases) {
   const [name, entry, config] = c;
   shareTest(`${name}-rspack`, entry, config);

diff --git a/packages/compat/plugin-swc/src/utils.ts b/packages/compat/plugin-swc/src/utils.ts
@@ -195,9 +195,9 @@ const getCoreJsVersion = (corejsPkgPath: string) => {
 
 const reduceTransformImportConfig = (
   options: NormalizedSourceConfig['transformImport'],
-): TransformImport[] | false => {
-  if (options === false || !options) {
-    return false;
+): TransformImport[] => {
+  if (!options) {
+    return [];
   }
 
   let imports: TransformImport[] = [];
@@ -279,7 +279,7 @@ export async function applyPluginConfig(
     rsbuildConfig.source?.transformImport,
   );
 
-  if (finalPluginImport !== false && finalPluginImport?.length) {
+  if (finalPluginImport?.length) {
     extensions.pluginImport ??= [];
     extensions.pluginImport.push(...finalPluginImport);
   }

diff --git a/packages/core/src/plugins/swc.ts b/packages/core/src/plugins/swc.ts
@@ -218,9 +218,9 @@ async function applyCoreJs(
 
 const reduceTransformImportConfig = (
   options: NormalizedSourceConfig['transformImport'],
-): TransformImport[] | false => {
-  if (options === false || !options) {
-    return false;
+): TransformImport[] => {
+  if (!options) {
+    return [];
   }
 
   let imports: TransformImport[] = [];
@@ -240,7 +240,7 @@ function applyTransformImport(
 ) {
   const finalPluginImport = reduceTransformImportConfig(pluginImport);
 
-  if (finalPluginImport !== false && finalPluginImport?.length) {
+  if (finalPluginImport?.length) {
     swcConfig.rspackExperiments ??= {};
     swcConfig.rspackExperiments.import ??= [];
     swcConfig.rspackExperiments.import.push(...finalPluginImport);

diff --git a/packages/core/src/types/config/source.ts b/packages/core/src/types/config/source.ts
@@ -63,8 +63,7 @@ export interface SourceConfig {
    */
   transformImport?:
     | TransformImportFn
-    | Array<TransformImport | TransformImportFn>
-    | false;
+    | Array<TransformImport | TransformImportFn>;
   /**
    * Configure a custom tsconfig.json file path to use, can be a relative or absolute path.
    * @default 'tsconfig.json'

diff --git a/packages/core/tests/__snapshots__/swc.test.ts.snap b/packages/core/tests/__snapshots__/swc.test.ts.snap
@@ -1,119 +1,5 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`plugin-swc > should add antd pluginImport 1`] = `
-{
-  "entry": {
-    "main": [
-      "./src/index.js",
-    ],
-  },
-  "module": {
-    "rules": [
-      {
-        "include": [
-          {
-            "and": [
-              "<ROOT>/packages/core/tests",
-              {
-                "not": /\\[\\\\\\\\/\\]node_modules\\[\\\\\\\\/\\]/,
-              },
-            ],
-          },
-          /\\\\\\.\\(\\?:ts\\|tsx\\|jsx\\|mts\\|cts\\)\\$/,
-        ],
-        "test": /\\\\\\.\\(\\?:js\\|jsx\\|mjs\\|cjs\\|ts\\|tsx\\|mts\\|cts\\)\\$/,
-        "type": "javascript/auto",
-        "use": [
-          {
-            "loader": "builtin:swc-loader",
-            "options": {
-              "env": {
-                "mode": undefined,
-                "targets": [
-                  "chrome >= 87",
-                  "edge >= 88",
-                  "firefox >= 78",
-                  "safari >= 14",
-                ],
-              },
-              "isModule": "unknown",
-              "jsc": {
-                "experimental": {
-                  "cacheRoot": "<ROOT>/packages/core/tests/node_modules/.cache/.swc",
-                },
-                "externalHelpers": true,
-                "parser": {
-                  "decorators": true,
-                  "syntax": "typescript",
-                  "tsx": false,
-                },
-                "preserveAllComments": true,
-                "transform": {
-                  "decoratorVersion": "2022-03",
-                  "legacyDecorator": false,
-                },
-              },
-            },
-          },
-        ],
-      },
-      {
-        "mimetype": {
-          "or": [
-            "text/javascript",
-            "application/javascript",
-          ],
-        },
-        "resolve": {
-          "fullySpecified": false,
-        },
-        "use": [
-          {
-            "loader": "builtin:swc-loader",
-            "options": {
-              "env": {
-                "mode": undefined,
-                "targets": [
-                  "chrome >= 87",
-                  "edge >= 88",
-                  "firefox >= 78",
-                  "safari >= 14",
-                ],
-              },
-              "isModule": "unknown",
-              "jsc": {
-                "experimental": {
-                  "cacheRoot": "<ROOT>/packages/core/tests/node_modules/.cache/.swc",
-                },
-                "externalHelpers": true,
-                "parser": {
-                  "decorators": true,
-                  "syntax": "typescript",
-                  "tsx": false,
-                },
-                "preserveAllComments": true,
-                "transform": {
-                  "decoratorVersion": "2022-03",
-                  "legacyDecorator": false,
-                },
-              },
-            },
-          },
-        ],
-      },
-    ],
-  },
-  "plugins": [
-    RsbuildCorePlugin {},
-  ],
-  "resolve": {
-    "alias": {
-      "@swc/helpers": "<ROOT>/node_modules/<PNPM_INNER>/@swc/helpers",
-    },
-  },
-}
-`;
-
 exports[`plugin-swc > should add browserslist 1`] = `
 [
   {
@@ -870,120 +756,6 @@ exports[`plugin-swc > should apply pluginImport correctly when ConfigChain 1`] =
 ]
 `;
 
-exports[`plugin-swc > should disable all pluginImport 1`] = `
-{
-  "entry": {
-    "main": [
-      "./src/index.js",
-    ],
-  },
-  "module": {
-    "rules": [
-      {
-        "include": [
-          {
-            "and": [
-              "<ROOT>/packages/core/tests",
-              {
-                "not": /\\[\\\\\\\\/\\]node_modules\\[\\\\\\\\/\\]/,
-              },
-            ],
-          },
-          /\\\\\\.\\(\\?:ts\\|tsx\\|jsx\\|mts\\|cts\\)\\$/,
-        ],
-        "test": /\\\\\\.\\(\\?:js\\|jsx\\|mjs\\|cjs\\|ts\\|tsx\\|mts\\|cts\\)\\$/,
-        "type": "javascript/auto",
-        "use": [
-          {
-            "loader": "builtin:swc-loader",
-            "options": {
-              "env": {
-                "mode": undefined,
-                "targets": [
-                  "chrome >= 87",
-                  "edge >= 88",
-                  "firefox >= 78",
-                  "safari >= 14",
-                ],
-              },
-              "isModule": "unknown",
-              "jsc": {
-                "experimental": {
-                  "cacheRoot": "<ROOT>/packages/core/tests/node_modules/.cache/.swc",
-                },
-                "externalHelpers": true,
-                "parser": {
-                  "decorators": true,
-                  "syntax": "typescript",
-                  "tsx": false,
-                },
-                "preserveAllComments": true,
-                "transform": {
-                  "decoratorVersion": "2022-03",
-                  "legacyDecorator": false,
-                },
-              },
-            },
-          },
-        ],
-      },
-      {
-        "mimetype": {
-          "or": [
-            "text/javascript",
-            "application/javascript",
-          ],
-        },
-        "resolve": {
-          "fullySpecified": false,
-        },
-        "use": [
-          {
-            "loader": "builtin:swc-loader",
-            "options": {
-              "env": {
-                "mode": undefined,
-                "targets": [
-                  "chrome >= 87",
-                  "edge >= 88",
-                  "firefox >= 78",
-                  "safari >= 14",
-                ],
-              },
-              "isModule": "unknown",
-              "jsc": {
-                "experimental": {
-                  "cacheRoot": "<ROOT>/packages/core/tests/node_modules/.cache/.swc",
-                },
-                "externalHelpers": true,
-                "parser": {
-                  "decorators": true,
-                  "syntax": "typescript",
-                  "tsx": false,
-                },
-                "preserveAllComments": true,
-                "transform": {
-                  "decoratorVersion": "2022-03",
-                  "legacyDecorator": false,
-                },
-              },
-            },
-          },
-        ],
-      },
-    ],
-  },
-  "plugins": [
-    RsbuildCorePlugin {},
-  ],
-  "resolve": {
-    "alias": {
-      "@swc/helpers": "<ROOT>/node_modules/<PNPM_INNER>/@swc/helpers",
-    },
-  },
-}
-`;
-
 exports[`plugin-swc > should disable pluginImport when return undefined 1`] = `
 [
   {

diff --git a/packages/core/tests/swc.test.ts b/packages/core/tests/swc.test.ts
@@ -105,45 +105,6 @@ describe('plugin-swc', () => {
     });
   });
 
-  it('should disable all pluginImport', async () => {
-    const rsbuild = await createStubRsbuild({
-      plugins: [pluginSwc(), pluginEntry()],
-      rsbuildConfig: {
-        source: {
-          entry: {
-            main: './src/index.js',
-          },
-          transformImport: false,
-        },
-      },
-    });
-
-    const bundlerConfigs = await rsbuild.initConfigs();
-
-    for (const bundlerConfig of bundlerConfigs) {
-      expect(bundlerConfig).toMatchSnapshot();
-    }
-  });
-
-  it('should add antd pluginImport', async () => {
-    const rsbuild = await createStubRsbuild({
-      rsbuildConfig: {
-        source: {
-          entry: {
-            main: './src/index.js',
-          },
-        },
-      },
-      plugins: [pluginSwc(), pluginEntry()],
-    });
-
-    const bundlerConfigs = await rsbuild.initConfigs();
-
-    for (const bundlerConfig of bundlerConfigs) {
-      expect(bundlerConfig).toMatchSnapshot();
-    }
-  });
-
   it('should allow to use `tools.swc` to configure swc-loader options', async () => {
     const rsbuild = await createStubRsbuild({
       rsbuildConfig: {

diff --git a/website/docs/en/config/source/transform-import.mdx b/website/docs/en/config/source/transform-import.mdx
@@ -4,7 +4,6 @@
 
 ```ts
 type TransformImport =
-  | false
   | Array<{
       libraryName: string;
       libraryDirectory?: string;

diff --git a/website/docs/zh/config/source/transform-import.mdx b/website/docs/zh/config/source/transform-import.mdx
@@ -4,7 +4,6 @@
 
 ```ts
 type TransformImport =
-  | false
   | Array<{
       libraryName: string;
       libraryDirectory?: string;