@rsbuild/plugin-babel 0.4.4 → 0.4.5

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { RsbuildPlugin } from '@rsbuild/core';
-import { ChainedConfigWithUtils, Decorators, NormalizedConfig, BundlerChain, ChainIdentifier } from '@rsbuild/shared';
+import { NormalizedConfig, RsbuildContext, RsbuildPlugin } from '@rsbuild/core';
+import { ChainedConfigWithUtils, NormalizedConfig as NormalizedConfig$1, BundlerChain, ChainIdentifier } from '@rsbuild/shared';
 import { PluginItem, TransformOptions } from '@babel/core';
 export { TransformOptions as BabelTransformOptions } from '@babel/core';
 
@@ -60,6 +60,28 @@ type BabelConfigUtils = {
      */
     addExcludes: (excludes: RuleCondition) => void;
 };
+type BabelLoaderOptions = TransformOptions & {
+    /**
+     * When set, the given directory will be used to cache the results of the loader.
+     */
+    cacheDirectory?: string | boolean;
+    /**
+     * Can be set to a custom value to force cache busting if the identifier changes.
+     */
+    cacheIdentifier?: string;
+    /**
+     * When set, each Babel transform output will be compressed with Gzip.
+     */
+    cacheCompression?: boolean;
+    /**
+     * The path of a module that exports a custom callback.
+     */
+    customize?: string | null;
+    /**
+     * Takes an array of context function names. E.g.
+     */
+    metadataSubscribers?: string[];
+};
 type PluginBabelOptions = {
     /**
      * Used to specify the files that need to be compiled by Babel.
@@ -73,26 +95,14 @@ type PluginBabelOptions = {
      * Options passed to `babel-loader`.
      * @see https://github.com/babel/babel-loader
      */
-    babelLoaderOptions?: ChainedConfigWithUtils<TransformOptions, BabelConfigUtils>;
+    babelLoaderOptions?: ChainedConfigWithUtils<BabelLoaderOptions, BabelConfigUtils>;
 };
 
-declare const getDefaultBabelOptions: (decorators: Decorators) => {
-    babelrc: boolean;
-    configFile: boolean;
-    compact: boolean;
-    plugins: (string | Decorators)[][];
-    presets: (string | {
-        allowNamespaces: boolean;
-        allExtensions: boolean;
-        allowDeclareFields: boolean;
-        optimizeConstEnums: boolean;
-        isTSX: boolean;
-    })[][];
-};
+declare const getDefaultBabelOptions: (config: NormalizedConfig, context: RsbuildContext) => BabelLoaderOptions;
 declare const pluginBabel: (options?: PluginBabelOptions) => RsbuildPlugin;
 
 declare const getBabelUtils: (config: TransformOptions) => BabelConfigUtils;
-declare const getUseBuiltIns: (config: NormalizedConfig) => false | "usage" | "entry";
+declare const getUseBuiltIns: (config: NormalizedConfig$1) => false | "usage" | "entry";
 declare const modifyBabelLoaderOptions: ({ chain, CHAIN_ID, modifier, }: {
     chain: BundlerChain;
     CHAIN_ID: ChainIdentifier;

package/dist/index.js

@@ -183,13 +183,30 @@ var DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS = {
   optimizeConstEnums: true,
   isTSX: true
 };
-var getDefaultBabelOptions = (decorators) => {
-  return {
+function getCacheDirectory(context, cacheDirectory) {
+  if (cacheDirectory) {
+    return (0, import_node_path2.isAbsolute)(cacheDirectory) ? cacheDirectory : (0, import_node_path2.join)(context.rootPath, cacheDirectory);
+  }
+  return (0, import_node_path2.join)(context.cachePath);
+}
+async function getCacheIdentifier(options) {
+  let identifier = `${(0, import_shared2.getNodeEnv)()}${JSON.stringify(options)}`;
+  const { version: coreVersion } = await import("@babel/core");
+  const loaderVersion = (await import_shared2.fse.readJSON((0, import_node_path2.join)(__dirname, "../compiled/babel-loader/package.json"))).version;
+  identifier += `@babel/core@${coreVersion}`;
+  identifier += `babel-loader@${loaderVersion}`;
+  return identifier;
+}
+var getDefaultBabelOptions = (config, context) => {
+  const options = {
     babelrc: false,
     configFile: false,
     compact: (0, import_shared2.isProd)(),
     plugins: [
-      [require.resolve("@babel/plugin-proposal-decorators"), decorators]
+      [
+        require.resolve("@babel/plugin-proposal-decorators"),
+        config.source.decorators
+      ]
     ],
     presets: [
       // TODO: only apply preset-typescript for ts file (isTSX & allExtensions false)
@@ -199,23 +216,36 @@ var getDefaultBabelOptions = (decorators) => {
       ]
     ]
   };
+  const { buildCache } = config.performance;
+  if (buildCache && context.bundlerType === "rspack") {
+    const cacheDirectory = getCacheDirectory(
+      context,
+      typeof buildCache === "boolean" ? void 0 : buildCache.cacheDirectory
+    );
+    options.cacheCompression = false;
+    options.cacheDirectory = (0, import_node_path2.join)(cacheDirectory, "babel-loader");
+  }
+  return options;
 };
 var pluginBabel = (options = {}) => ({
   name: PLUGIN_BABEL_NAME,
   setup(api) {
+    const getBabelOptions = async () => {
+      const config = api.getNormalizedConfig();
+      const baseOptions = getDefaultBabelOptions(config, api.context);
+      const mergedOptions = applyUserBabelConfig(
+        (0, import_shared2.cloneDeep)(baseOptions),
+        options.babelLoaderOptions
+      );
+      if (mergedOptions.cacheDirectory && !mergedOptions.cacheIdentifier) {
+        mergedOptions.cacheIdentifier = await getCacheIdentifier(mergedOptions);
+      }
+      return mergedOptions;
+    };
     api.modifyBundlerChain({
       order: "pre",
       handler: async (chain, { CHAIN_ID }) => {
-        const config = api.getNormalizedConfig();
-        const getBabelOptions = () => {
-          const baseConfig = getDefaultBabelOptions(config.source.decorators);
-          const userBabelConfig = applyUserBabelConfig(
-            (0, import_shared2.cloneDeep)(baseConfig),
-            options.babelLoaderOptions
-          );
-          return userBabelConfig;
-        };
-        const babelOptions = getBabelOptions();
+        const babelOptions = await getBabelOptions();
         const babelLoader = import_node_path2.default.resolve(
           __dirname,
           "../compiled/babel-loader/index.js"

package/dist/index.mjs

@@ -9,7 +9,7 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
   throw Error('Dynamic require of "' + x + '" is not supported');
 });
 
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.46.1_typescript@5.3.2/node_modules/@modern-js/module-tools/shims/esm.js
+// ../../node_modules/.pnpm/@modern-js+module-tools@2.47.0_typescript@5.3.2/node_modules/@modern-js/module-tools/shims/esm.js
 import { fileURLToPath } from "url";
 import path from "path";
 var getFilename = () => fileURLToPath(import.meta.url);
@@ -17,11 +17,13 @@ var getDirname = () => path.dirname(getFilename());
 var __dirname = /* @__PURE__ */ getDirname();
 
 // src/plugin.ts
-import path2 from "path";
+import path2, { isAbsolute as isAbsolute2, join } from "path";
 import {
+  fse,
   isProd,
   castArray as castArray2,
   cloneDeep,
+  getNodeEnv,
   SCRIPT_REGEX
 } from "@rsbuild/shared";
 
@@ -169,13 +171,30 @@ var DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS = {
   optimizeConstEnums: true,
   isTSX: true
 };
-var getDefaultBabelOptions = (decorators) => {
-  return {
+function getCacheDirectory(context, cacheDirectory) {
+  if (cacheDirectory) {
+    return isAbsolute2(cacheDirectory) ? cacheDirectory : join(context.rootPath, cacheDirectory);
+  }
+  return join(context.cachePath);
+}
+async function getCacheIdentifier(options) {
+  let identifier = `${getNodeEnv()}${JSON.stringify(options)}`;
+  const { version: coreVersion } = await import("@babel/core");
+  const loaderVersion = (await fse.readJSON(join(__dirname, "../compiled/babel-loader/package.json"))).version;
+  identifier += `@babel/core@${coreVersion}`;
+  identifier += `babel-loader@${loaderVersion}`;
+  return identifier;
+}
+var getDefaultBabelOptions = (config, context) => {
+  const options = {
     babelrc: false,
     configFile: false,
     compact: isProd(),
     plugins: [
-      [__require.resolve("@babel/plugin-proposal-decorators"), decorators]
+      [
+        __require.resolve("@babel/plugin-proposal-decorators"),
+        config.source.decorators
+      ]
     ],
     presets: [
       // TODO: only apply preset-typescript for ts file (isTSX & allExtensions false)
@@ -185,23 +204,36 @@ var getDefaultBabelOptions = (decorators) => {
       ]
     ]
   };
+  const { buildCache } = config.performance;
+  if (buildCache && context.bundlerType === "rspack") {
+    const cacheDirectory = getCacheDirectory(
+      context,
+      typeof buildCache === "boolean" ? void 0 : buildCache.cacheDirectory
+    );
+    options.cacheCompression = false;
+    options.cacheDirectory = join(cacheDirectory, "babel-loader");
+  }
+  return options;
 };
 var pluginBabel = (options = {}) => ({
   name: PLUGIN_BABEL_NAME,
   setup(api) {
+    const getBabelOptions = async () => {
+      const config = api.getNormalizedConfig();
+      const baseOptions = getDefaultBabelOptions(config, api.context);
+      const mergedOptions = applyUserBabelConfig(
+        cloneDeep(baseOptions),
+        options.babelLoaderOptions
+      );
+      if (mergedOptions.cacheDirectory && !mergedOptions.cacheIdentifier) {
+        mergedOptions.cacheIdentifier = await getCacheIdentifier(mergedOptions);
+      }
+      return mergedOptions;
+    };
     api.modifyBundlerChain({
       order: "pre",
       handler: async (chain, { CHAIN_ID }) => {
-        const config = api.getNormalizedConfig();
-        const getBabelOptions = () => {
-          const baseConfig = getDefaultBabelOptions(config.source.decorators);
-          const userBabelConfig = applyUserBabelConfig(
-            cloneDeep(baseConfig),
-            options.babelLoaderOptions
-          );
-          return userBabelConfig;
-        };
-        const babelOptions = getBabelOptions();
+        const babelOptions = await getBabelOptions();
         const babelLoader = path2.resolve(
           __dirname,
           "../compiled/babel-loader/index.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/plugin-babel",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "description": "Babel plugin for Rsbuild",
   "repository": {
     "type": "git",
@@ -28,16 +28,16 @@
     "@babel/plugin-proposal-decorators": "^7.23.2",
     "@types/babel__core": "^7.20.3",
     "upath": "2.0.1",
-    "@rsbuild/shared": "0.4.4"
+    "@rsbuild/shared": "0.4.5"
   },
   "devDependencies": {
     "@types/node": "16.x",
     "typescript": "^5.3.0",
-    "@rsbuild/core": "0.4.4",
-    "@scripts/test-helper": "0.4.4"
+    "@rsbuild/core": "0.4.5",
+    "@scripts/test-helper": "0.4.5"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^0.4.4"
+    "@rsbuild/core": "^0.4.5"
   },
   "publishConfig": {
     "access": "public",