feat!: use rolldown to bundle jsvascript

Author: northword

package.json

@@ -68,6 +68,14 @@
   "directories": {
     "lib": "dist"
   },
+  "peerDependencies": {
+    "esbuild": "^0.27.2"
+  },
+  "peerDependenciesMeta": {
+    "esbuild": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@fluent/syntax": "^0.19.0",
     "adm-zip": "^0.5.16",
@@ -76,7 +84,6 @@
     "chokidar": "^5.0.0",
     "commander": "^14.0.3",
     "es-toolkit": "^1.45.1",
-    "esbuild": "^0.27.4",
     "esrap": "^2.2.3",
     "fs-extra": "^11.3.4",
     "hookable": "^6.0.1",

src/config.ts

@@ -110,6 +110,7 @@ const defaultConfig = {
       dts: "typings/prefs.d.ts",
     },
     esbuildOptions: [],
+    bundle: [],
     makeManifest: {
       enable: true,
       template: {

src/core/builder/esbuild.ts

@@ -1,7 +1,7 @@
 import type { BuildOptions, BuildResult } from "esbuild";
 import type { BuildConfig } from "../../types/config.js";
 import { resolve } from "node:path";
-import { build as buildAsync } from "esbuild";
+
 import { logger } from "../../utils/logger.js";
 
 export function resolveConfig(dist: string, esbuildOptions: BuildConfig["esbuildOptions"]): BuildOptions[] {
@@ -27,6 +27,8 @@ export default async function esbuild(dist: string, esbuildOptions: BuildConfig[
 
   const options = resolveConfig(dist, esbuildOptions);
 
+  const { build: buildAsync } = await import("esbuild");
+
   return await Promise.all(
     options.map(esbuildOption =>
       buildAsync(esbuildOption),

src/core/builder/index.ts

@@ -11,6 +11,7 @@ import buildLocale from "./fluent.js";
 import buildManifest from "./manifest.js";
 import buildPrefs from "./prefs.js";
 import replaceDefine from "./replace.js";
+import rolldownBuild from "./rolldown.js";
 import buildUpdateJson from "./update-json.js";
 import pack from "./zip.js";
 
@@ -72,8 +73,11 @@ export default class Build extends Base {
   }
 
   async bundle(): Promise<void> {
-    const { dist, build: { esbuildOptions } } = this.ctx;
-    await esbuild(dist, esbuildOptions);
+    const { dist, build: { esbuildOptions, bundle } } = this.ctx;
+    if (esbuildOptions.length !== 0)
+      await esbuild(dist, esbuildOptions);
+
+    await rolldownBuild(dist, bundle);
     await this.ctx.hooks.callHook("build:bundle", this.ctx);
   }
 

src/core/builder/rolldown.ts

@@ -0,0 +1,67 @@
+import type { InputOptions, OutputOptions } from "rolldown";
+import type { BuildConfig, BundleItem, Config } from "../../types/config.js";
+import { resolve } from "node:path";
+import process from "node:process";
+import { rolldown } from "rolldown";
+import { toArray } from "../../utils/string.js";
+
+export type RolldownBuildOptions = InputOptions & { output?: OutputOptions | OutputOptions[] };
+
+export function resolveConfig(dist: Config["dist"], configs: BundleItem[]): RolldownBuildOptions[] {
+  const distAbsolute = resolve(dist);
+
+  // ensure output.file and output.dir are in dist folder
+  return configs.map((config) => {
+    // Extract config fields from new format with proper typing
+    const { input, minify, rolldown: rolldownInputConfig } = config;
+
+    // Normalize output directory path
+    const outputDir = `${dist}/addon`;
+    const resolvedDir = resolve(outputDir).startsWith(distAbsolute)
+      ? outputDir
+      : `${dist}/${outputDir}`;
+
+    return {
+      ...rolldownInputConfig,
+      input,
+      transform: {
+        ...rolldownInputConfig?.transform,
+        target: "firefox140",
+        define: {
+          __env__: `"${process.env.NODE_ENV || "production"}"`,
+          ...(rolldownInputConfig?.transform?.define),
+        },
+      },
+      output: {
+        dir: resolvedDir,
+        format: "esm",
+        minify,
+        // Since the Zotero sandbox environment does not support loading subpackages,
+        // we hope to output a single file
+        // Error: export declarations may only appear at top level of a module
+        codeSplitting: false,
+      },
+    };
+  });
+}
+
+export default async function rolldownBuild(dist: string, bundleConfigs: BuildConfig["bundle"]): Promise<void> {
+  const configs = toArray(bundleConfigs);
+
+  if (configs.length === 0)
+    return;
+
+  const options = resolveConfig(dist, configs);
+
+  await Promise.all(
+    options.map(async (rolldownOption) => {
+      const { output, ...inputOptions } = rolldownOption;
+      const bundle = await rolldown(inputOptions);
+      if (output) {
+        const outputConfig = Array.isArray(output) ? output : [output];
+        await bundle.write(outputConfig[0]);
+      }
+      await bundle.close();
+    }),
+  );
+}

src/types/config.ts

@@ -1,9 +1,12 @@
 import type { GitCommit } from "changelogen";
-import type { BuildOptions } from "esbuild";
+import type { BuildOptions as esbuildConfig } from "esbuild";
+import type { InputOptions, RolldownPluginOption, TransformOptions } from "rolldown";
+import type { MinifyOptions } from "rolldown/experimental";
 import type { LogLevelType } from "../utils/logger.js";
 import type { Context } from "./index.js";
 import type { Manifest } from "./manifest.js";
 import type { UpdateJSON } from "./update-json.js";
+import type { Arrayable } from "./utils.js";
 
 export interface Config {
   /**
@@ -174,6 +177,58 @@ export interface Config {
   logLevel: LogLevelType;
 }
 
+export interface BundleItem {
+  /**
+   *
+   * @example
+   *
+   * ```ts
+   * // Single entry
+   * entries: "src/index.ts"                            // -> outDir/index.js
+   *
+   * // Multiple entries
+   * entries: [
+   *   "src/index.ts",                                 // -> outDir/index.js
+   *   "src/another-entry.ts"                          // -> outDir/another-entry.js
+   * ]
+   *
+   * // Named multiple entries
+   * entries: {
+   *   bootstrap: "src/bootstrap.ts",                  // -> outDir/bootstrap.js
+   *   content: "src/content.ts",                      // -> outDir/content.js
+   *   'components/Foo': 'src/components/Foo.js',      // -> outDir/components/Foo.js
+   * }
+   * ```
+   *
+   * The outDir is based on {@linkcode Config.dist | dist/build/addon }.
+   *
+   * @see https://rolldown.rs/reference/InputOptions.input
+   */
+  input: InputOptions["input"];
+
+  /**
+   * Replace global variables or [property accessors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors) with the provided values.
+   *
+   * See Oxc's [`define` option](https://oxc.rs/docs/guide/usage/transformer/global-variable-replacement.html#define) for more details.
+   *
+   */
+  define?: TransformOptions["define"];
+
+  /**
+   * Minify the output using rolldown.
+   *
+   * Defaults to `false` if not provided.
+   */
+  minify?: boolean | "dce-only" | MinifyOptions;
+
+  /**
+   * Options passed to rolldown.
+   *
+   * See [rolldown config options](https://rolldown.rs/reference/config-options) for more details.
+   */
+  rolldown?: Omit<InputOptions, "input"> & { plugins?: RolldownPluginOption[] };
+}
+
 export interface BuildConfig {
   /**
    * The static assets.
@@ -294,22 +349,42 @@ export interface BuildConfig {
     dts: false | string;
   };
   /**
-   * Configurations of esbuild.
+   * Configurations for code bundler (rolldown).
+   *
+   * Paths should be relative to the root directory of the project.
+   * And if `output.file` and `output.dir` not start with `dist`,
+   * `dist/` will be automatically added as a prefix.
+   *
+   * 代码捆绑器（rolldown）的配置。
+   *
+   * 路径应相对于项目根目录。
+   * 其中"output.file"和"output.dir"若不以 `dist` 开头，
+   * 则会自动添加 `dist/` 前缀。
+   *
+   * @default []
+   *
+   * @deprecated Use `build.bundle` instead.
+   *
+   */
+  esbuildOptions: esbuildConfig[];
+  /**
+   * Configurations for code bundler (rolldown).
    *
    * Paths should be relative to the root directory of the project.
-   * And if `outfile` and `outdir` not start with `dist`,
+   * And if `output.file` and `output.dir` not start with `dist`,
    * `dist/` will be automatically added as a prefix.
    *
-   * esbuild 配置。
+   * 代码捆绑器（rolldown）的配置。
    *
    * 路径应相对于项目根目录。
-   * 其中“outfile”和“outdir”若不以 `dist` 开头，
+   * 其中"output.file"和"output.dir"若不以 `dist` 开头，
    * 则会自动添加 `dist/` 前缀。
    *
    * @default []
    *
    */
-  esbuildOptions: BuildOptions[];
+  bundle: Arrayable<BundleItem>;
+
   /**
    * Make manifest.json.
    *

src/types/index.ts

@@ -4,6 +4,7 @@ import type { Config, Hooks } from "./config.js";
 import type { RecursivePartial } from "./utils.js";
 
 export { Config, Hooks };
+export type { BuildConfig } from "./config.js";
 
 /**
  * User config

src/types/utils.ts

@@ -23,3 +23,6 @@ type RecursiveOptionalKeys<T> = {
 export type RecursivePickOptional<T> = {
   [K in keyof T as K extends RecursiveOptionalKeys<T> ? K : never]?: T[K] extends object ? RecursivePickOptional<T[K]> : T[K];
 };
+
+export type Awaitable<T> = T | Promise<T>;
+export type Arrayable<T> = T | T[];