@lynx-js/rspeedy 0.9.3 → 0.9.5

package/CHANGELOG.md

@@ -1,5 +1,83 @@
 # @lynx-js/rspeedy
 
+## 0.9.5
+
+### Patch Changes
+
+- Support `source.preEntry`. ([#750](https://github.com/lynx-family/lynx-stack/pull/750))
+
+  Add a script before the entry file of each page. This script will be executed before the page code.
+  It can be used to execute global logics, such as injecting polyfills, setting global styles, etc.
+
+  example：
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+  export default defineConfig({
+    source: {
+      preEntry: './src/polyfill.ts',
+    },
+  })
+  ```
+
+- Bump Rsbuild v1.3.20 with Rspack v1.3.10. ([#799](https://github.com/lynx-family/lynx-stack/pull/799))
+
+- Add `callerName` option to `createRspeedy`. ([#757](https://github.com/lynx-family/lynx-stack/pull/757))
+
+  It can be accessed by Rsbuild plugins through [`api.context.callerName`](https://rsbuild.dev/api/javascript-api/instance#contextcallername), and execute different logic based on this identifier.
+
+  ```js
+  export const myPlugin = {
+    name: 'my-plugin',
+    setup(api) {
+      const { callerName } = api.context
+
+      if (callerName === 'rslib') {
+        // ...
+      } else if (callerName === 'rspeedy') {
+        // ...
+      }
+    },
+  }
+  ```
+
+- Support `performance.buildCache`. ([#766](https://github.com/lynx-family/lynx-stack/pull/766))
+
+- Updated dependencies [[`fbc4fbb`](https://github.com/lynx-family/lynx-stack/commit/fbc4fbbdb572ad7128a33dc06e8d8a026d18e388)]:
+  - @lynx-js/webpack-dev-transport@0.1.3
+
+## 0.9.4
+
+### Patch Changes
+
+- Bump Rsbuild v1.3.17 with Rspack v1.3.9. ([#708](https://github.com/lynx-family/lynx-stack/pull/708))
+
+- Support `performance.profile`. ([#691](https://github.com/lynx-family/lynx-stack/pull/691))
+
+- Support CLI flag `--mode` to specify the build mode. ([#723](https://github.com/lynx-family/lynx-stack/pull/723))
+
+- Enable native Rsdoctor plugin by default. ([#688](https://github.com/lynx-family/lynx-stack/pull/688))
+
+  Set `tools.rsdoctor.experiments.enableNativePlugin` to `false` to use the old JS plugin.
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig({
+    tools: {
+      rsdoctor: {
+        experiments: {
+          enableNativePlugin: false,
+        },
+      },
+    },
+  })
+  ```
+
+  See [Rsdoctor - 1.0](https://rsdoctor.dev/blog/release/release-note-1_0#-faster-analysis) for more details.
+
+- Bump Rsbuild v1.3.14 with Rspack v1.3.8. ([#630](https://github.com/lynx-family/lynx-stack/pull/630))
+
 ## 0.9.3
 
 ### Patch Changes
@@ -10,7 +88,7 @@
 
 ### Patch Changes
 
-- Support cli option `--no-env` to disable loading of .env files ([#483](https://github.com/lynx-family/lynx-stack/pull/483))
+- Support CLI option `--no-env` to disable loading of `.env` files ([#483](https://github.com/lynx-family/lynx-stack/pull/483))
 
 - Bump Rsbuild v1.3.8 with Rspack v1.3.5. ([#579](https://github.com/lynx-family/lynx-stack/pull/579))
 
@@ -46,9 +124,9 @@
 
 ### Patch Changes
 
-- Support cli flag `--base` to specify the base path of the server. ([#387](https://github.com/lynx-family/lynx-stack/pull/387))
+- Support CLI flag `--base` to specify the base path of the server. ([#387](https://github.com/lynx-family/lynx-stack/pull/387))
 
-- Support cli option `--environment` to specify the name of environment to build ([#462](https://github.com/lynx-family/lynx-stack/pull/462))
+- Support CLI flag `--environment` to specify the name of environment to build ([#462](https://github.com/lynx-family/lynx-stack/pull/462))
 
 - Select the most appropriate network interface. ([#457](https://github.com/lynx-family/lynx-stack/pull/457))
 
@@ -58,7 +136,7 @@
 
   See [Node.js - TypeScript](https://nodejs.org/api/typescript.html) for more details.
 
-- Support cli option `--env-mode` to specify the env mode to load the `.env.[mode]` file. ([#453](https://github.com/lynx-family/lynx-stack/pull/453))
+- Support CLI flag `--env-mode` to specify the env mode to load the `.env.[mode]` file. ([#453](https://github.com/lynx-family/lynx-stack/pull/453))
 
 - Support `dev.hmr` and `dev.liveReload`. ([#458](https://github.com/lynx-family/lynx-stack/pull/458))
 

package/dist/index.d.ts

@@ -31,6 +31,79 @@ import { rspack } from '@rsbuild/core';
 import type { ToolsConfig } from '@rsbuild/core';
 import type { WatchFiles } from '@rsbuild/core';
 
+/**
+ * {@inheritdoc Performance.buildCache}
+ *
+ * @beta
+ */
+export declare interface BuildCache {
+    /**
+     * Add additional cache digests, the previous build cache will be invalidated
+     * when any value in the array changes.
+     *
+     * @defaultValue undefined
+     *
+     * @example
+     *
+     * Add `process.env.SOME_ENV` to the cache digest.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     buildCache: {
+     *       cacheDigest: [process.env.SOME_ENV],
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    cacheDigest?: Array<string | undefined> | undefined;
+    /**
+     * The output directory of the cache files.
+     *
+     * @defaultValue 'node_modules/.cache'
+     */
+    cacheDirectory?: string | undefined;
+    /**
+     * An array of files containing build dependencies.
+     * Rspack will use the hash of each of these files to invalidate the persistent cache.
+     *
+     * @remarks
+     *
+     * Rspeedy will use the following configuration files as the default build dependencies:
+     *
+     * - `package.json`
+     *
+     * - `tsconfig.json` (or `source.tsconfigPath`)
+     *
+     * - `.env`, `.env.*`
+     *
+     * - `tailwindcss.config.*`
+     *
+     * When using Rspeedy CLI, it will also automatically add
+     * `lynx.config.js` to the build dependencies.
+     *
+     * @example
+     *
+     * Add `postcss.config.js` to the build dependencies.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     buildCache: {
+     *       buildDependencies: ['postcss.config.js'],
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    buildDependencies?: string[] | undefined;
+}
+
 /**
  * {@inheritdoc Performance.chunkSplit}
  *
@@ -417,7 +490,7 @@ export declare type ConsoleType = 'log' | 'warn' | 'error' | 'info' | 'debug' |
  *
  * @public
  */
-export declare function createRspeedy({ cwd, rspeedyConfig, loadEnv, environment }: CreateRspeedyOptions): Promise<RspeedyInstance>;
+export declare function createRspeedy({ cwd, rspeedyConfig, loadEnv, environment, callerName, }: CreateRspeedyOptions): Promise<RspeedyInstance>;
 
 /**
  * The options of `createRspeedy` method.
@@ -448,6 +521,42 @@ export declare interface CreateRspeedyOptions {
      * @defaultValue []
      */
     environment?: CreateRsbuildOptions['environment'];
+    /**
+     * The name of the framework or tool that is currently invoking Rsbuild.
+     * This allows plugins to tailor their behavior based on the calling context.
+     *
+     * @example
+     *
+     * Rsbuild plugins can access this value via `api.context.callerName`.
+     *
+     * ```js
+     * export function myPlugin() {
+     *   return {
+     *     name: 'my-plugin',
+     *     setup(api) {
+     *       // Log the name of the tool invoking Rsbuild
+     *       console.log(`Called by: ${api.context.callerName}`);
+     *
+     *       // Conditionally apply plugin logic based on caller
+     *       if (api.context.callerName === 'rspeedy') {
+     *         api.modifyRsbuildConfig((config) => {
+     *           // Apply rspeedy-specific config changes
+     *           return config;
+     *         });
+     *       } else if (api.context.callerName === 'rslib') {
+     *         api.modifyRsbuildConfig((config) => {
+     *           // Apply rslib-specific config changes
+     *           return config;
+     *         });
+     *       }
+     *     }
+     *   };
+     * }
+     * ```
+     *
+     * @defaultValue 'rspeedy'
+     */
+    callerName?: string;
 }
 
 /**
@@ -1104,7 +1213,9 @@ export declare interface DistPath extends DistPathConfig {
  * ```js
  * import { defineConfig } from '@lynx-js/rspeedy'
  * export default defineConfig({
- *   entry: './src/pages/main/index.js',
+ *   source: {
+ *     entry: './src/pages/main/index.js',
+ *   }
  * })
  * ```
  *
@@ -1115,7 +1226,9 @@ export declare interface DistPath extends DistPathConfig {
  * ```js
  * import { defineConfig } from '@lynx-js/rspeedy'
  * export default defineConfig({
- *   entry: ['./src/prefetch.js', './src/pages/main/index.js'],
+ *   source: {
+ *     entry: ['./src/prefetch.js', './src/pages/main/index.js'],
+ *   }
  * })
  * ```
  *
@@ -1126,10 +1239,12 @@ export declare interface DistPath extends DistPathConfig {
  * ```js
  * import { defineConfig } from '@lynx-js/rspeedy'
  * export default defineConfig({
- *   entry: {
- *     foo: './src/pages/foo/index.js',
- *     bar: ['./src/pages/bar/index.js', './src/post.js'], // multiple entry modules is allowed
- *   },
+ *   source: {
+ *     entry: {
+ *       foo: './src/pages/foo/index.js',
+ *       bar: ['./src/pages/bar/index.js', './src/post.js'], // multiple entry modules is allowed
+ *     }
+ *   }
  * })
  * ```
  *
@@ -1140,12 +1255,14 @@ export declare interface DistPath extends DistPathConfig {
  * ```js
  * import { defineConfig } from '@lynx-js/rspeedy'
  * export default defineConfig({
- *   entry: {
- *     foo: './src/pages/foo/index.js',
- *     bar: {
- *       import: ['./src/prefetch.js', './src/pages/bar'],
- *     },
- *   },
+ *   source: {
+ *     entry: {
+ *       foo: './src/pages/foo/index.js',
+ *       bar: {
+ *         import: ['./src/prefetch.js', './src/pages/bar'],
+ *       }
+ *     }
+ *   }
  * })
  * ```
  * @public
@@ -1887,10 +2004,73 @@ export declare interface Output {
  * @public
  */
 export declare interface Performance {
+    /**
+     * Enable or configure persistent build cache.
+     *
+     * @beta This feature is experimental and may be changed in the future.
+     *
+     * @example
+     *
+     * Enable persistent build cache.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     buildCache: true,
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * Customize build cache.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     buildCache: {
+     *       cacheDigest: [process.env.SOME_ENV],
+     *       buildDependencies: ['postcss.config.js'],
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    buildCache?: BuildCache | boolean | undefined;
     /**
      * {@link Performance.chunkSplit} is used to configure the chunk splitting strategy.
      */
     chunkSplit?: ChunkSplit | ChunkSplitBySize | ChunkSplitCustom | undefined;
+    /**
+     * Whether capture timing information in the build time and the runtime, the same as the {@link https://rspack.dev/config/other-options#profile | profile} config of Rspack.
+     *
+     * @remarks
+     *
+     * This option would be `true` when `DEBUG` environment variable contains `rspeedy`.
+     *
+     * @example
+     *
+     * Enable profile.
+     *
+     * - Rsbuild will auto-generate `dist/stats.json` file through bundle analyzer.
+     *
+     * - Rspack will include the build time information when generating `stats.json`.
+     *
+     * - Frameworks like ReactLynx will include runtime information using `console.profile`.
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: { profile: true },
+     * })
+     * ```
+     */
+    profile?: boolean | undefined;
     /**
      * Whether to remove `console.[methodName]` in production build.
      *
@@ -2381,7 +2561,9 @@ export declare interface Source {
      * ```js
      * import { defineConfig } from '@lynx-js/rspeedy'
      * export default defineConfig({
-     *   entry: './src/pages/main/index.js',
+     *   source: {
+     *     entry: './src/pages/main/index.js',
+     *   },
      * })
      * ```
      *
@@ -2392,7 +2574,9 @@ export declare interface Source {
      * ```js
      * import { defineConfig } from '@lynx-js/rspeedy'
      * export default defineConfig({
-     *   entry: ['./src/prefetch.js', './src/pages/main/index.js'],
+     *   source: {
+     *     entry: ['./src/prefetch.js', './src/pages/main/index.js'],
+     *   },
      * })
      * ```
      *
@@ -2403,9 +2587,11 @@ export declare interface Source {
      * ```js
      * import { defineConfig } from '@lynx-js/rspeedy'
      * export default defineConfig({
-     *   entry: {
-     *     foo: './src/pages/foo/index.js',
-     *     bar: ['./src/pages/bar/index.js', './src/post.js'], // multiple entry modules is allowed
+     *   source: {
+     *     entry: {
+     *       foo: './src/pages/foo/index.js',
+     *       bar: ['./src/pages/bar/index.js', './src/post.js'], // multiple entry modules is allowed
+     *     },
      *   },
      * })
      * ```
@@ -2417,10 +2603,12 @@ export declare interface Source {
      * ```js
      * import { defineConfig } from '@lynx-js/rspeedy'
      * export default defineConfig({
-     *   entry: {
-     *     foo: './src/pages/foo/index.js',
-     *     bar: {
-     *       import: ['./src/prefetch.js', './src/pages/bar'],
+     *   source: {
+     *     entry: {
+     *       foo: './src/pages/foo/index.js',
+     *       bar: {
+     *         import: ['./src/prefetch.js', './src/pages/bar'],
+     *       },
      *     },
      *   },
      * })
@@ -2563,6 +2751,28 @@ export declare interface Source {
      * ```
      */
     include?: Rspack.RuleSetCondition[] | undefined;
+    /**
+     * Add a script before the entry file of each page. This script will be executed before the page code.
+     * It can be used to execute global logics, such as injecting polyfills, setting global styles, etc.
+     *
+     * @remarks
+     *
+     * See {@link https://rsbuild.dev/config/source/pre-entry | source.preEntry} for more details.
+     *
+     * @example
+     *
+     * Relative path will be resolved relative to the project root directory.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     * export default defineConfig({
+     *   source: {
+     *     preEntry: './src/polyfill.ts',
+     *   },
+     * })
+     * ```
+     */
+    preEntry?: string | string[] | undefined;
     /**
      * The {@link TransformImport} option transforms the import paths to enable modular imports from subpaths of third-party packages, similar to the functionality provided by {@link https://npmjs.com/package/babel-plugin-import | babel-plugin-import}.
      *

package/dist/index.js

@@ -112,7 +112,7 @@ var __webpack_modules__ = {
         });
         var core_ = __webpack_require__("@rsbuild/core");
         var package_namespaceObject = {
-            i8: "0.9.3"
+            i8: "0.9.5"
         };
         const version = package_namespaceObject.i8;
         const rspackVersion = core_.rspack.rspackVersion;
@@ -254,11 +254,18 @@ __webpack_require__.m = __webpack_modules__;
 var external_node_path_ = __webpack_require__("node:path");
 var core_ = __webpack_require__("@rsbuild/core");
 function applyDefaultRspeedyConfig(config) {
-    const ret = (0, core_.mergeRsbuildConfig)(config, {
+    const ret = (0, core_.mergeRsbuildConfig)({
         output: {
             filename: getFilename(config.output?.filename)
+        },
+        tools: {
+            rsdoctor: {
+                experiments: {
+                    enableNativePlugin: true
+                }
+            }
         }
-    });
+    }, config);
     return ret;
 }
 const DEFAULT_FILENAME = '[name].[platform].bundle';
@@ -348,6 +355,7 @@ function toRsbuildConfig(config) {
             entry: toRsbuildEntry(config.source?.entry),
             exclude: config.source?.exclude,
             include: config.source?.include,
+            preEntry: config.source?.preEntry,
             transformImport: config.source?.transformImport,
             tsconfigPath: config.source?.tsconfigPath
         },
@@ -360,7 +368,9 @@ function toRsbuildConfig(config) {
         },
         plugins: config.plugins,
         performance: {
+            buildCache: config.performance?.buildCache,
             chunkSplit: config.performance?.chunkSplit,
+            profile: config.performance?.profile,
             removeConsole: toRsbuildRemoveConsole(config),
             printFileSize: config.performance?.printFileSize ?? true
         },
@@ -386,14 +396,15 @@ function toRsbuildRemoveConsole(config) {
     ];
     return config.performance?.removeConsole;
 }
-async function createRspeedy({ cwd = process.cwd(), rspeedyConfig = {}, loadEnv = true, environment = [] }) {
+async function createRspeedy({ cwd = process.cwd(), rspeedyConfig = {}, loadEnv = true, environment = [], callerName = 'rspeedy' }) {
     const config = applyDefaultRspeedyConfig(rspeedyConfig);
     const [rspeedy, { applyDefaultPlugins }] = await Promise.all([
         (0, core_.createRsbuild)({
             cwd,
             loadEnv,
             rsbuildConfig: toRsbuildConfig(config),
-            environment
+            environment,
+            callerName
         }),
         __webpack_require__.e("src_plugins_index_ts").then(__webpack_require__.bind(__webpack_require__, "./src/plugins/index.ts"))
     ]);