@rsbuild/plugin-babel 0.0.0-next-20231103091827

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+<p align="center">
+  <a href="https://rsbuild.dev" target="blank"><img src="https://github.com/web-infra-dev/rsbuild/assets/7237365/84abc13e-b620-468f-a90b-dbf28e7e9427" alt="Rsbuild Logo" /></a>
+</p>
+
+# Rsbuild
+
+Unleash the power of Rspack with the out-of-the-box build tool.
+
+## Documentation
+
+https://rsbuild.dev/
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
+
+## License
+
+Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

package/dist/helper.d.ts

@@ -0,0 +1,4 @@
+import type { BabelConfigUtils, BabelTransformOptions } from './types';
+export declare const getBabelUtils: (config: BabelTransformOptions) => BabelConfigUtils;
+export type BabelConfig = BabelTransformOptions | ((config: BabelTransformOptions, utils: BabelConfigUtils) => BabelTransformOptions | void);
+export declare const applyUserBabelConfig: (defaultOptions: BabelTransformOptions, userBabelConfig?: BabelConfig | BabelConfig[], extraBabelUtils?: Partial<BabelConfigUtils>) => BabelTransformOptions;

package/dist/helper.js

@@ -0,0 +1,144 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var helper_exports = {};
+__export(helper_exports, {
+  applyUserBabelConfig: () => applyUserBabelConfig,
+  getBabelUtils: () => getBabelUtils
+});
+module.exports = __toCommonJS(helper_exports);
+var import_path = require("path");
+var import_shared = require("@rsbuild/shared");
+var import_upath = __toESM(require("upath"));
+const normalizeToPosixPath = (p) => import_upath.default.normalizeSafe((0, import_path.normalize)(p || "")).replace(/^([a-zA-Z]+):/, (_, m) => `/${m.toLowerCase()}`);
+const formatPath = (originPath) => {
+  if ((0, import_path.isAbsolute)(originPath)) {
+    return originPath.split(import_path.sep).join("/");
+  }
+  return originPath;
+};
+const getPluginItemName = (item) => {
+  if (typeof item === "string") {
+    return formatPath(item);
+  }
+  if (Array.isArray(item) && typeof item[0] === "string") {
+    return formatPath(item[0]);
+  }
+  return null;
+};
+const addPlugins = (plugins, config) => {
+  if (config.plugins) {
+    config.plugins.push(...plugins);
+  } else {
+    config.plugins = plugins;
+  }
+};
+const addPresets = (presets, config) => {
+  if (config.presets) {
+    config.presets.push(...presets);
+  } else {
+    config.presets = presets;
+  }
+};
+const removePlugins = (plugins, config) => {
+  if (!config.plugins) {
+    return;
+  }
+  const removeList = (0, import_shared.castArray)(plugins);
+  config.plugins = config.plugins.filter((item) => {
+    const name = getPluginItemName(item);
+    if (name) {
+      return !removeList.find((removeItem) => name.includes(removeItem));
+    }
+    return true;
+  });
+};
+const removePresets = (presets, config) => {
+  if (!config.presets) {
+    return;
+  }
+  const removeList = (0, import_shared.castArray)(presets);
+  config.presets = config.presets.filter((item) => {
+    const name = getPluginItemName(item);
+    if (name) {
+      return !removeList.find((removeItem) => name.includes(removeItem));
+    }
+    return true;
+  });
+};
+const modifyPresetOptions = (presetName, options, presets = []) => {
+  presets.forEach((preset, index) => {
+    if (Array.isArray(preset)) {
+      if (typeof preset[0] === "string" && normalizeToPosixPath(preset[0]).includes(presetName)) {
+        preset[1] = {
+          ...preset[1] || {},
+          ...options
+          // `options` is specific to different presets
+        };
+      }
+    } else if (typeof preset === "string" && normalizeToPosixPath(preset).includes(presetName)) {
+      presets[index] = [preset, options];
+    }
+  });
+};
+const getBabelUtils = (config) => {
+  const noop = () => {
+  };
+  return {
+    addPlugins: (plugins) => addPlugins(plugins, config),
+    addPresets: (presets) => addPresets(presets, config),
+    removePlugins: (plugins) => removePlugins(plugins, config),
+    removePresets: (presets) => removePresets(presets, config),
+    // `addIncludes` and `addExcludes` are noop functions by default,
+    // It can be overridden by `extraBabelUtils`.
+    addIncludes: noop,
+    addExcludes: noop,
+    // Compat `presetEnvOptions` and `presetReactOptions` in Eden.
+    modifyPresetEnvOptions: (options) => modifyPresetOptions("@babel/preset-env", options, config.presets || []),
+    modifyPresetReactOptions: (options) => modifyPresetOptions("@babel/preset-react", options, config.presets || [])
+  };
+};
+const applyUserBabelConfig = (defaultOptions, userBabelConfig, extraBabelUtils) => {
+  if (userBabelConfig) {
+    const babelUtils = {
+      ...getBabelUtils(defaultOptions),
+      ...extraBabelUtils
+    };
+    return (0, import_shared.mergeChainedOptions)(
+      defaultOptions,
+      userBabelConfig || {},
+      babelUtils
+    );
+  }
+  return defaultOptions;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  applyUserBabelConfig,
+  getBabelUtils
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { pluginBabel } from './plugin';
+export { getBabelUtils } from './helper';
+export type { PresetEnvOptions, PresetEnvTargets, PresetEnvBuiltIns, BabelConfigUtils, BabelTransformOptions } from './types';

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  getBabelUtils: () => import_helper.getBabelUtils,
+  pluginBabel: () => import_plugin.pluginBabel
+});
+module.exports = __toCommonJS(src_exports);
+var import_plugin = require("./plugin");
+var import_helper = require("./helper");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getBabelUtils,
+  pluginBabel
+});

package/dist/plugin.d.ts

@@ -0,0 +1,13 @@
+import { DefaultRsbuildPlugin } from '@rsbuild/shared';
+import type { PluginBabelOptions } from './types';
+/**
+ * The `@babel/preset-typescript` default options.
+ */
+export declare const DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS: {
+  allowNamespaces: boolean;
+  allExtensions: boolean;
+  allowDeclareFields: boolean;
+  optimizeConstEnums: boolean;
+  isTSX: boolean;
+};
+export declare const pluginBabel: (options?: PluginBabelOptions) => DefaultRsbuildPlugin;

package/dist/plugin.js

@@ -0,0 +1,116 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_exports = {};
+__export(plugin_exports, {
+  DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS: () => DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS,
+  pluginBabel: () => pluginBabel
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_shared2 = require("@rsbuild/shared");
+var import_lodash = require("lodash");
+var import_helper = require("./helper");
+const DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS = {
+  allowNamespaces: true,
+  allExtensions: true,
+  allowDeclareFields: true,
+  // aligns Babel's behavior with TypeScript's default behavior.
+  // https://babeljs.io/docs/en/babel-preset-typescript#optimizeconstenums
+  optimizeConstEnums: true,
+  isTSX: true
+};
+const pluginBabel = (options = {}) => ({
+  name: "plugin-babel",
+  setup(api) {
+    if (api.context.bundlerType === "webpack") {
+      return;
+    }
+    api.modifyBundlerChain(async (chain, { CHAIN_ID, isProd }) => {
+      const getBabelOptions = () => {
+        const includes2 = [];
+        const excludes2 = [];
+        const babelUtils = {
+          addIncludes(items) {
+            if (Array.isArray(items)) {
+              includes2.push(...items);
+            } else {
+              includes2.push(items);
+            }
+          },
+          addExcludes(items) {
+            if (Array.isArray(items)) {
+              excludes2.push(...items);
+            } else {
+              excludes2.push(items);
+            }
+          }
+        };
+        const baseConfig = {
+          plugins: [],
+          presets: [
+            // TODO: only apply preset-typescript for ts file (isTSX & allExtensions false)
+            [
+              require.resolve("@babel/preset-typescript"),
+              DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS
+            ]
+          ]
+        };
+        const userBabelConfig = (0, import_helper.applyUserBabelConfig)(
+          (0, import_lodash.cloneDeep)(baseConfig),
+          options,
+          babelUtils
+        );
+        const babelOptions2 = {
+          babelrc: false,
+          configFile: false,
+          compact: isProd,
+          ...userBabelConfig
+        };
+        return {
+          babelOptions: babelOptions2,
+          includes: includes2,
+          excludes: excludes2
+        };
+      };
+      const { babelOptions, includes = [], excludes = [] } = getBabelOptions();
+      const rule = chain.module.rule(CHAIN_ID.RULE.JS);
+      includes.forEach((condition) => {
+        rule.include.add(condition);
+      });
+      excludes.forEach((condition) => {
+        rule.exclude.add(condition);
+      });
+      rule.test((0, import_shared2.mergeRegex)(import_shared2.JS_REGEX, import_shared2.TS_REGEX)).use(CHAIN_ID.USE.BABEL).after(CHAIN_ID.USE.SWC).loader(require.resolve("babel-loader")).options(babelOptions);
+    });
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_BABEL_PRESET_TYPESCRIPT_OPTIONS,
+  pluginBabel
+});

package/dist/types.d.ts

@@ -0,0 +1,52 @@
+import type { ChainedConfig } from '@rsbuild/shared';
+import type { PluginItem as BabelPlugin, PluginOptions as BabelPluginOptions, TransformOptions as BabelTransformOptions } from '@babel/core';
+export { BabelPlugin, BabelPluginOptions, BabelTransformOptions };
+export type PresetEnvTargets = string | string[] | Record<string, string>;
+export type PresetEnvBuiltIns = 'usage' | 'entry' | false;
+export type PresetEnvOptions = {
+  targets?: PresetEnvTargets;
+  bugfixes?: boolean;
+  spec?: boolean;
+  loose?: boolean;
+  modules?: 'amd' | 'umd' | 'systemjs' | 'commonjs' | 'cjs' | 'auto' | false;
+  debug?: boolean;
+  include?: string[];
+  exclude?: string[];
+  useBuiltIns?: PresetEnvBuiltIns;
+  corejs?: string | {
+    version: string;
+    proposals: boolean;
+  };
+  forceAllTransforms?: boolean;
+  configPath?: string;
+  ignoreBrowserslistConfig?: boolean;
+  browserslistEnv?: string;
+  shippedProposals?: boolean;
+};
+export interface SharedBabelPresetReactOptions {
+  development?: boolean;
+  throwIfNamespace?: boolean;
+}
+export interface AutomaticRuntimePresetReactOptions extends SharedBabelPresetReactOptions {
+  runtime?: 'automatic';
+  importSource?: string;
+}
+export interface ClassicRuntimePresetReactOptions extends SharedBabelPresetReactOptions {
+  runtime?: 'classic';
+  pragma?: string;
+  pragmaFrag?: string;
+  useBuiltIns?: boolean;
+  useSpread?: boolean;
+}
+export type PresetReactOptions = AutomaticRuntimePresetReactOptions | ClassicRuntimePresetReactOptions;
+export type BabelConfigUtils = {
+  addPlugins: (plugins: BabelPlugin[]) => void;
+  addPresets: (presets: BabelPlugin[]) => void;
+  addIncludes: (includes: string | RegExp | (string | RegExp)[]) => void;
+  addExcludes: (excludes: string | RegExp | (string | RegExp)[]) => void;
+  removePlugins: (plugins: string | string[]) => void;
+  removePresets: (presets: string | string[]) => void;
+  modifyPresetEnvOptions: (options: PresetEnvOptions) => void;
+  modifyPresetReactOptions: (options: PresetReactOptions) => void;
+};
+export type PluginBabelOptions = ChainedConfig<BabelTransformOptions, BabelConfigUtils>;

package/dist/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@rsbuild/plugin-babel",
+  "version": "0.0.0-next-20231103091827",
+  "description": "Babel plugin for Rsbuild",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rsbuild",
+    "directory": "packages/plugin-babel"
+  },
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@babel/core": "^7.23.2",
+    "@babel/preset-typescript": "^7.23.2",
+    "@types/babel__core": "^7.20.3",
+    "babel-loader": "9.1.3",
+    "lodash": "^4.17.21",
+    "upath": "2.0.1",
+    "@rsbuild/shared": "0.0.0-next-20231103091827"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.200",
+    "@types/node": "^16",
+    "typescript": "^5.2.2",
+    "@rsbuild/core": "0.0.0-next-20231103091827",
+    "@rsbuild/test-helper": "0.0.0-next-20231103091827"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "modern build",
+    "dev": "modern build --watch"
+  }
+}