feat: support externalHelpers

e2e/cases/external-helpers/__fixtures__/src/index.ts

@@ -0,0 +1,5 @@
+export default class FOO {
+  get bar() {
+    return;
+  }
+}

e2e/cases/external-helpers/__fixtures__/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@rslib/tsconfig/base",
+  "compilerOptions": {
+    "baseUrl": "./"
+  },
+  "include": ["src"]
+}

e2e/cases/external-helpers/__snapshots__/index.test.ts.snap

@@ -0,0 +1,137 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`should external @swc/helpers when externalHelpers is true 1`] = `
+"import * as __WEBPACK_EXTERNAL_MODULE__swc_helpers_class_call_check__ from \\"@swc/helpers/_/_class_call_check\\";
+import * as __WEBPACK_EXTERNAL_MODULE__swc_helpers_create_class__ from \\"@swc/helpers/_/_create_class\\";
+var _class_call_check_namespaceObject = __WEBPACK_EXTERNAL_MODULE__swc_helpers_class_call_check__;
+var _create_class_namespaceObject = __WEBPACK_EXTERNAL_MODULE__swc_helpers_create_class__;
+var src_FOO = /*#__PURE__*/ function() {
+    \\"use strict\\";
+    function FOO() {
+        (0, _class_call_check_namespaceObject._)(this, FOO);
+    }
+    (0, _create_class_namespaceObject._)(FOO, [
+        {
+            key: \\"bar\\",
+            get: function() {}
+        }
+    ]);
+    return FOO;
+}();
+export { src_FOO as default };
+"
+`;
+
+exports[`should external @swc/helpers when externalHelpers is true 2`] = `
+"import * as __WEBPACK_EXTERNAL_MODULE__swc_helpers_class_call_check__ from \\"@swc/helpers/_/_class_call_check\\";
+import * as __WEBPACK_EXTERNAL_MODULE__swc_helpers_create_class__ from \\"@swc/helpers/_/_create_class\\";
+var _class_call_check_namespaceObject = __WEBPACK_EXTERNAL_MODULE__swc_helpers_class_call_check__;
+var _create_class_namespaceObject = __WEBPACK_EXTERNAL_MODULE__swc_helpers_create_class__;
+var src_FOO = /*#__PURE__*/ function() {
+    \\"use strict\\";
+    function FOO() {
+        (0, _class_call_check_namespaceObject._)(this, FOO);
+    }
+    (0, _create_class_namespaceObject._)(FOO, [
+        {
+            key: \\"bar\\",
+            get: function() {}
+        }
+    ]);
+    return FOO;
+}();
+export { src_FOO as default };
+"
+`;
+
+exports[`should not external @swc/helpers by default 1`] = `
+"function _class_call_check(instance, Constructor) {
+    if (!(instance instanceof Constructor)) throw new TypeError(\\"Cannot call a class as a function\\");
+}
+function _defineProperties(target, props) {
+    for(var i = 0; i < props.length; i++){
+        var descriptor = props[i];
+        descriptor.enumerable = descriptor.enumerable || false;
+        descriptor.configurable = true;
+        if (\\"value\\" in descriptor) descriptor.writable = true;
+        Object.defineProperty(target, descriptor.key, descriptor);
+    }
+}
+function _create_class(Constructor, protoProps, staticProps) {
+    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+    if (staticProps) _defineProperties(Constructor, staticProps);
+    return Constructor;
+}
+var src_FOO = /*#__PURE__*/ function() {
+    \\"use strict\\";
+    function FOO() {
+        _class_call_check(this, FOO);
+    }
+    _create_class(FOO, [
+        {
+            key: \\"bar\\",
+            get: function() {}
+        }
+    ]);
+    return FOO;
+}();
+export { src_FOO as default };
+"
+`;
+
+exports[`should respect user override externalHelpers config 1`] = `
+"function _class_call_check(instance, Constructor) {
+    if (!(instance instanceof Constructor)) throw new TypeError(\\"Cannot call a class as a function\\");
+}
+function _defineProperties(target, props) {
+    for(var i = 0; i < props.length; i++){
+        var descriptor = props[i];
+        descriptor.enumerable = descriptor.enumerable || false;
+        descriptor.configurable = true;
+        if (\\"value\\" in descriptor) descriptor.writable = true;
+        Object.defineProperty(target, descriptor.key, descriptor);
+    }
+}
+function _create_class(Constructor, protoProps, staticProps) {
+    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+    if (staticProps) _defineProperties(Constructor, staticProps);
+    return Constructor;
+}
+var src_FOO = /*#__PURE__*/ function() {
+    \\"use strict\\";
+    function FOO() {
+        _class_call_check(this, FOO);
+    }
+    _create_class(FOO, [
+        {
+            key: \\"bar\\",
+            get: function() {}
+        }
+    ]);
+    return FOO;
+}();
+export { src_FOO as default };
+"
+`;
+
+exports[`should respect user override externalHelpers config 2`] = `
+"import * as __WEBPACK_EXTERNAL_MODULE__swc_helpers_class_call_check__ from \\"@swc/helpers/_/_class_call_check\\";
+import * as __WEBPACK_EXTERNAL_MODULE__swc_helpers_create_class__ from \\"@swc/helpers/_/_create_class\\";
+var _class_call_check_namespaceObject = __WEBPACK_EXTERNAL_MODULE__swc_helpers_class_call_check__;
+var _create_class_namespaceObject = __WEBPACK_EXTERNAL_MODULE__swc_helpers_create_class__;
+var src_FOO = /*#__PURE__*/ function() {
+    \\"use strict\\";
+    function FOO() {
+        (0, _class_call_check_namespaceObject._)(this, FOO);
+    }
+    (0, _create_class_namespaceObject._)(FOO, [
+        {
+            key: \\"bar\\",
+            get: function() {}
+        }
+    ]);
+    return FOO;
+}();
+export { src_FOO as default };
+"
+`;

e2e/cases/external-helpers/config-override/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "external-helpers-config-override-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "@swc/helpers": "0.5.13"
+  }
+}

e2e/cases/external-helpers/config-override/rslib.config.ts

@@ -0,0 +1,43 @@
+import { generateBundleEsmConfig } from '@e2e/helper';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      syntax: 'es5',
+      externalHelpers: true,
+      tools: {
+        swc: {
+          jsc: {
+            externalHelpers: false,
+          },
+        },
+      },
+      output: {
+        distPath: {
+          root: './dist/1',
+        },
+      },
+    }),
+    generateBundleEsmConfig({
+      syntax: 'es5',
+      tools: {
+        swc: {
+          jsc: {
+            externalHelpers: true,
+          },
+        },
+      },
+      output: {
+        distPath: {
+          root: './dist/2',
+        },
+      },
+    }),
+  ],
+  source: {
+    entry: {
+      index: '../__fixtures__/src/index.ts',
+    },
+  },
+});

e2e/cases/external-helpers/default/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "external-helpers-default-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}

e2e/cases/external-helpers/default/rslib.config.ts

@@ -0,0 +1,15 @@
+import { generateBundleEsmConfig } from '@e2e/helper';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      syntax: 'es5',
+    }),
+  ],
+  source: {
+    entry: {
+      index: '../__fixtures__/src/index.ts',
+    },
+  },
+});

e2e/cases/external-helpers/index.test.ts

@@ -0,0 +1,50 @@
+import { join } from 'node:path';
+import { buildAndGetResults, proxyConsole } from '@e2e/helper';
+import stripAnsi from 'strip-ansi';
+import { expect, test } from 'vitest';
+
+test('should not external @swc/helpers by default', async () => {
+  const fixturePath = join(__dirname, 'default');
+  const { entries } = await buildAndGetResults(fixturePath);
+
+  expect(entries.esm).toMatchSnapshot();
+});
+
+test('should throw error when @swc/helpers is not be installed when externalHelpers is true', async () => {
+  const { logs, restore } = proxyConsole();
+
+  const fixturePath = join(__dirname, 'no-deps');
+  try {
+    await buildAndGetResults(fixturePath);
+  } catch {}
+
+  const logStrings = logs.map((log) => stripAnsi(log));
+
+  expect(logStrings).toMatchInlineSnapshot(`
+    [
+      "error   externalHelpers is enabled, but the @swc/helpers dependency declaration was not found in package.json.",
+    ]
+  `);
+
+  restore();
+});
+
+test('should external @swc/helpers when externalHelpers is true', async () => {
+  const fixturePath = join(__dirname, 'true');
+  const { entries } = await buildAndGetResults(fixturePath);
+
+  // autoExternal is true
+  expect(entries.esm0).toMatchSnapshot();
+  // autoExternal is false
+  expect(entries.esm1).toMatchSnapshot();
+});
+
+test('should respect user override externalHelpers config', async () => {
+  const fixturePath = join(__dirname, 'config-override');
+  const { entries } = await buildAndGetResults(fixturePath);
+
+  // override externalHelpers false
+  expect(entries.esm0).toMatchSnapshot();
+  // override externalHelpers true
+  expect(entries.esm1).toMatchSnapshot();
+});

e2e/cases/external-helpers/no-deps/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "external-helpers-no-deps-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}

e2e/cases/external-helpers/no-deps/rslib.config.ts

@@ -0,0 +1,16 @@
+import { generateBundleEsmConfig } from '@e2e/helper';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      syntax: 'es5',
+      externalHelpers: true,
+    }),
+  ],
+  source: {
+    entry: {
+      index: '../__fixtures__/src/index.ts',
+    },
+  },
+});

e2e/cases/external-helpers/true/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "external-helpers-true-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "@swc/helpers": "0.5.13"
+  }
+}

e2e/cases/external-helpers/true/rslib.config.ts

@@ -0,0 +1,31 @@
+import { generateBundleEsmConfig } from '@e2e/helper';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      syntax: 'es5',
+      externalHelpers: true,
+      output: {
+        distPath: {
+          root: './dist/1',
+        },
+      },
+    }),
+    generateBundleEsmConfig({
+      syntax: 'es5',
+      externalHelpers: true,
+      autoExternal: false,
+      output: {
+        distPath: {
+          root: './dist/2',
+        },
+      },
+    }),
+  ],
+  source: {
+    entry: {
+      index: '../__fixtures__/src/index.ts',
+    },
+  },
+});

e2e/cases/syntax/__snapshots__/index.test.ts.snap

@@ -12,13 +12,13 @@ export { Foo };
 `;
 
 exports[`should downgrade class private method with output.syntax config 1`] = `
-"function _class_private_method_get(receiver, privateSet, fn) {
+"function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) throw new TypeError(\\"Cannot initialize the same private elements twice on an object\\");
+}
+function _class_private_method_get(receiver, privateSet, fn) {
     if (!privateSet.has(receiver)) throw new TypeError(\\"attempted to get private field on non-instance\\");
     return fn;
 }
-function _check_private_redeclaration(obj, privateCollection) {
-    if (privateCollection.has(obj)) throw new TypeError(\\"Cannot initialize the same private elements twice on an object\\");
-}
 function _class_private_method_init(obj, privateSet) {
     _check_private_redeclaration(obj, privateSet);
     privateSet.add(obj);