@lynx-js/rspeedy 0.9.4 → 0.9.6

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @lynx-js/rspeedy
 
+## 0.9.6
+
+### Patch Changes
+
+- Support `output.inlineScripts`, which controls whether to inline scripts into Lynx bundle (`.lynx.bundle`). ([#874](https://github.com/lynx-family/lynx-stack/pull/874))
+
+  Only background thread scripts can remain non-inlined, whereas the main thread script is always inlined.
+
+  example:
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig({
+    output: {
+      inlineScripts: false,
+    },
+  })
+  ```
+
+- Bump Rsbuild v1.3.21 with Rspack v1.3.11. ([#863](https://github.com/lynx-family/lynx-stack/pull/863))
+
+- Updated dependencies [[`5b67bde`](https://github.com/lynx-family/lynx-stack/commit/5b67bde8a7286b9dcc727c9707cf83020bb5abfa)]:
+  - @lynx-js/chunk-loading-webpack-plugin@0.2.1
+
+## 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

package/dist/cli/main.js

@@ -194,9 +194,9 @@ var __webpack_modules__ = {
             NW: ()=>debugList,
             fF: ()=>debug
         });
-        var _rsbuild_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("@rsbuild/core");
-        var picocolors__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__("../../../node_modules/.pnpm/picocolors@1.1.1/node_modules/picocolors/picocolors.js");
-        var picocolors__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/ __webpack_require__.n(picocolors__WEBPACK_IMPORTED_MODULE_1__);
+        var _rsbuild_core__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__("@rsbuild/core");
+        var picocolors__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("../../../node_modules/.pnpm/picocolors@1.1.1/node_modules/picocolors/picocolors.js");
+        var picocolors__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/ __webpack_require__.n(picocolors__WEBPACK_IMPORTED_MODULE_0__);
         const isDebug = ()=>{
             if (!process.env['DEBUG']) return false;
             const values = process.env['DEBUG'].toLocaleLowerCase().split(',');
@@ -206,12 +206,12 @@ var __webpack_modules__ = {
                 '*'
             ].some((key)=>values.includes(key));
         };
-        const label = picocolors__WEBPACK_IMPORTED_MODULE_1___default().bgCyan('lynx');
+        const label = picocolors__WEBPACK_IMPORTED_MODULE_0___default().bgCyan('lynx');
         const debug = (message)=>{
             if (isDebug()) {
                 const result = 'string' == typeof message ? message : message();
-                _rsbuild_core__WEBPACK_IMPORTED_MODULE_0__.logger.level = 'verbose';
-                _rsbuild_core__WEBPACK_IMPORTED_MODULE_0__.logger.debug(`${label} ${result}`);
+                _rsbuild_core__WEBPACK_IMPORTED_MODULE_1__.logger.level = 'verbose';
+                _rsbuild_core__WEBPACK_IMPORTED_MODULE_1__.logger.debug(`${label} ${result}`);
             }
         };
         const debugList = (prefix, messages)=>debug(()=>`${prefix} ${[

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;
 }
 
 /**
@@ -1849,6 +1958,31 @@ export declare interface Output {
      * - `contenthash`: The hash value of the file content. The hash value will only change when the content of the file itself changes.
      */
     filenameHash?: boolean | string | undefined;
+    /**
+     * The {@link Output.inlineScripts} option controls whether to inline scripts into Lynx bundle (`.lynx.bundle`).
+     *
+     * @remarks
+     *
+     * If no value is provided, the default value would be `true`.
+     *
+     * This is different with {@link https://rsbuild.dev/config/output/inline-scripts | output.inlineScripts } since we normally want to inline scripts in Lynx bundle (`.lynx.bundle`).
+     *
+     * Only background thread scripts can remain non-inlined, whereas the main thread script is always inlined.
+     *
+     * @example
+     *
+     * Disable inlining background thread scripts.
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   output: {
+     *     inlineScripts: false,
+     *   },
+     * })
+     * ```
+     */
+    inlineScripts?: boolean | undefined;
     /**
      * The {@link Output.legalComments} controls how to handle the legal comment.
      *
@@ -1895,6 +2029,43 @@ 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.
      */
@@ -2415,7 +2586,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',
+     *   },
      * })
      * ```
      *
@@ -2426,7 +2599,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'],
+     *   },
      * })
      * ```
      *
@@ -2437,9 +2612,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
+     *     },
      *   },
      * })
      * ```
@@ -2451,10 +2628,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'],
+     *       },
      *     },
      *   },
      * })
@@ -2597,6 +2776,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.4"
+            i8: "0.9.6"
         };
         const version = package_namespaceObject.i8;
         const rspackVersion = core_.rspack.rspackVersion;
@@ -256,7 +256,8 @@ var core_ = __webpack_require__("@rsbuild/core");
 function applyDefaultRspeedyConfig(config) {
     const ret = (0, core_.mergeRsbuildConfig)({
         output: {
-            filename: getFilename(config.output?.filename)
+            filename: getFilename(config.output?.filename),
+            inlineScripts: true
         },
         tools: {
             rsdoctor: {
@@ -355,6 +356,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
         },
@@ -367,6 +369,7 @@ function toRsbuildConfig(config) {
         },
         plugins: config.plugins,
         performance: {
+            buildCache: config.performance?.buildCache,
             chunkSplit: config.performance?.chunkSplit,
             profile: config.performance?.profile,
             removeConsole: toRsbuildRemoveConsole(config),
@@ -394,14 +397,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"))
     ]);

package/dist/src_cli_build_ts.js

@@ -15,7 +15,7 @@ export const __webpack_modules__ = {
         async function build(cwd, buildOptions) {
             const shouldExit = 'true' !== process.env['RSDOCTOR'] || (0, _utils_is_ci_js__WEBPACK_IMPORTED_MODULE_4__.y)();
             try {
-                const { createRspeedyOptions } = await (0, _init_js__WEBPACK_IMPORTED_MODULE_3__.S)(cwd, buildOptions);
+                const { createRspeedyOptions } = await (0, _init_js__WEBPACK_IMPORTED_MODULE_3__.init)(cwd, buildOptions);
                 const rspeedy = await (0, _create_rspeedy_js__WEBPACK_IMPORTED_MODULE_2__.S)(createRspeedyOptions);
                 await rspeedy.build();
             } catch (error) {
@@ -27,7 +27,7 @@ export const __webpack_modules__ = {
     },
     "./src/cli/init.ts": function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {
         __webpack_require__.d(__webpack_exports__, {
-            S: ()=>init
+            init: ()=>init
         });
         var external_node_fs_ = __webpack_require__("node:fs");
         var external_node_path_ = __webpack_require__("node:path");
@@ -104,6 +104,15 @@ export const __webpack_modules__ = {
                 cwd,
                 configPath: options.config
             });
+            if (rspeedyConfig.performance?.buildCache) if (true === rspeedyConfig.performance.buildCache) rspeedyConfig.performance.buildCache = {
+                buildDependencies: [
+                    configPath
+                ]
+            };
+            else {
+                rspeedyConfig.performance.buildCache.buildDependencies ??= [];
+                rspeedyConfig.performance.buildCache.buildDependencies.push(configPath);
+            }
             const createRspeedyOptions = {
                 cwd,
                 rspeedyConfig
@@ -134,7 +143,8 @@ export const __webpack_modules__ = {
         function applyDefaultRspeedyConfig(config) {
             const ret = (0, core_.mergeRsbuildConfig)({
                 output: {
-                    filename: getFilename(config.output?.filename)
+                    filename: getFilename(config.output?.filename),
+                    inlineScripts: true
                 },
                 tools: {
                     rsdoctor: {
@@ -233,6 +243,7 @@ export const __webpack_modules__ = {
                     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
                 },
@@ -245,6 +256,7 @@ export const __webpack_modules__ = {
                 },
                 plugins: config.plugins,
                 performance: {
+                    buildCache: config.performance?.buildCache,
                     chunkSplit: config.performance?.chunkSplit,
                     profile: config.performance?.profile,
                     removeConsole: toRsbuildRemoveConsole(config),
@@ -272,14 +284,15 @@ export const __webpack_modules__ = {
             ];
             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"))
             ]);

package/dist/src_cli_commands_ts.js

@@ -40,7 +40,7 @@ export const __webpack_modules__ = {
         });
         var core_ = __webpack_require__("@rsbuild/core");
         var package_namespaceObject = {
-            i8: "0.9.4"
+            i8: "0.9.6"
         };
         const version = package_namespaceObject.i8;
         const rspackVersion = core_.rspack.rspackVersion;

package/dist/src_cli_dev_ts.js

@@ -17,7 +17,7 @@ export const __webpack_modules__ = {
         async function dev(cwd, devOptions) {
             let onBeforeRestart = [];
             try {
-                const { rspeedyConfig, configPath, createRspeedyOptions } = await (0, _init_js__WEBPACK_IMPORTED_MODULE_4__.S)(cwd, devOptions);
+                const { rspeedyConfig, configPath, createRspeedyOptions } = await (0, _init_js__WEBPACK_IMPORTED_MODULE_4__.init)(cwd, devOptions);
                 const watchedFiles = [
                     configPath
                 ];
@@ -70,7 +70,7 @@ export const __webpack_modules__ = {
     },
     "./src/cli/init.ts": function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {
         __webpack_require__.d(__webpack_exports__, {
-            S: ()=>init
+            init: ()=>init
         });
         var external_node_fs_ = __webpack_require__("node:fs");
         var external_node_path_ = __webpack_require__("node:path");
@@ -147,6 +147,15 @@ export const __webpack_modules__ = {
                 cwd,
                 configPath: options.config
             });
+            if (rspeedyConfig.performance?.buildCache) if (true === rspeedyConfig.performance.buildCache) rspeedyConfig.performance.buildCache = {
+                buildDependencies: [
+                    configPath
+                ]
+            };
+            else {
+                rspeedyConfig.performance.buildCache.buildDependencies ??= [];
+                rspeedyConfig.performance.buildCache.buildDependencies.push(configPath);
+            }
             const createRspeedyOptions = {
                 cwd,
                 rspeedyConfig
@@ -177,7 +186,8 @@ export const __webpack_modules__ = {
         function applyDefaultRspeedyConfig(config) {
             const ret = (0, core_.mergeRsbuildConfig)({
                 output: {
-                    filename: getFilename(config.output?.filename)
+                    filename: getFilename(config.output?.filename),
+                    inlineScripts: true
                 },
                 tools: {
                     rsdoctor: {
@@ -276,6 +286,7 @@ export const __webpack_modules__ = {
                     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
                 },
@@ -288,6 +299,7 @@ export const __webpack_modules__ = {
                 },
                 plugins: config.plugins,
                 performance: {
+                    buildCache: config.performance?.buildCache,
                     chunkSplit: config.performance?.chunkSplit,
                     profile: config.performance?.profile,
                     removeConsole: toRsbuildRemoveConsole(config),
@@ -315,14 +327,15 @@ export const __webpack_modules__ = {
             ];
             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"))
             ]);