rolldown-plugin-require-cjs 0.1.4 → 0.2.0

package/README.md

@@ -18,6 +18,44 @@ See more: https://x.com/sanxiaozhizi/status/1968580207322808812
 npm i rolldown-plugin-require-cjs
 ```
 
+## Options
+
+```ts
+export interface Options {
+  include?: Array<string | RegExp> | string | RegExp
+  exclude?: Array<string | RegExp> | string | RegExp
+  order?: 'pre' | 'post' | undefined
+  /**
+   * A function to determine whether a module should be transformed.
+   * Return `true` to force transformation, `false` to skip transformation,
+   * or `undefined` to let the plugin decide automatically.
+   */
+  shouldTransform?: string[] | TransformFn
+  /**
+   * Whether to transform Node.js built-in modules (e.g., `fs`, `path`)
+   * to `process.getBuiltinModule()` calls, which has the best performance.
+   *
+   * Note: `process.getBuiltinModule` is available since Node.js 20.16.0 and 22.3.0.
+   */
+  builtinNodeModules?: boolean
+}
+
+/**
+ * @returns A boolean or a promise that resolves to a boolean,
+ * or `undefined` to let the plugin decide automatically.
+ */
+export type TransformFn = (
+  /**
+   * The module ID (path) being imported.
+   */
+  id: string,
+  /**
+   * The module ID (path) of the importer.
+   */
+  importer: string,
+) => Awaitable<boolean | undefined | void>
+```
+
 ## Example
 
 ```ts

package/dist/index.d.ts

@@ -3,6 +3,10 @@ import { Plugin } from "rolldown";
 //#region src/options.d.ts
 type FilterPattern = Array<string | RegExp> | string | RegExp;
 type Awaitable<T> = T | Promise<T>;
+/**
+* @returns A boolean or a promise that resolves to a boolean,
+* or `undefined` to let the plugin decide automatically.
+*/
 type TransformFn = (id: string, importer: string) => Awaitable<boolean | undefined | void>;
 interface Options {
   include?: FilterPattern;
@@ -12,12 +16,15 @@ interface Options {
   * A function to determine whether a module should be transformed.
   * Return `true` to force transformation, `false` to skip transformation,
   * or `undefined` to let the plugin decide automatically.
-  *
-  * @param id The module ID (path) being imported.
-  * @param importer The module ID (path) of the importer.
-  * @returns A boolean or a promise that resolves to a boolean, or `undefined`.
   */
   shouldTransform?: string[] | TransformFn;
+  /**
+  * Whether to transform Node.js built-in modules (e.g., `fs`, `path`)
+  * to `process.getBuiltinModule()` calls, which has the best performance.
+  *
+  * Note: `process.getBuiltinModule` is available since Node.js 20.16.0 and 22.3.0.
+  */
+  builtinNodeModules?: boolean;
 }
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
 type OptionsResolved = Overwrite<Required<Options>, Pick<Options, "order"> & {