@lynx-js/rspeedy 0.14.1 → 0.14.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @lynx-js/rspeedy
 
+## 0.14.2
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @lynx-js/web-rsbuild-server-middleware@0.20.2
+
 ## 0.14.1
 
 ### Patch Changes
@@ -521,7 +528,7 @@
 
 - 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.
+  It can be accessed by Rsbuild plugins through [`api.context.callerName`](https://rsbuild.rs/api/javascript-api/instance#contextcallername), and execute different logic based on this identifier.
 
   ```js
   export const myPlugin = {
@@ -652,7 +659,7 @@
 
 - Support `output.distPath.*`. ([#366](https://github.com/lynx-family/lynx-stack/pull/366))
 
-  See [Rsbuild - distPath](https://rsbuild.dev/config/output/dist-path) for all available options.
+  See [Rsbuild - distPath](https://rsbuild.rs/config/output/dist-path) for all available options.
 
 - Support `performance.printFileSize` ([#336](https://github.com/lynx-family/lynx-stack/pull/336))
 

package/dist/index.d.ts

@@ -367,7 +367,7 @@ export declare interface Config {
      *
      * If the value of `mode` is `'development'`:
      *
-     * - Enable HMR and register the {@link https://rspack.dev/plugins/webpack/hot-module-replacement-plugin | HotModuleReplacementPlugin}.
+     * - Enable HMR and register the {@link https://rspack.rs/plugins/webpack/hot-module-replacement-plugin | HotModuleReplacementPlugin}.
      *
      * - Generate JavaScript source maps, but do not generate CSS source maps. See {@link Output.sourceMap} for details.
      *
@@ -383,7 +383,7 @@ export declare interface Config {
      *
      * If the value of `mode` is `'production'`:
      *
-     * - Enable JavaScript code minification and register the {@link https://rspack.dev/plugins/rspack/swc-js-minimizer-rspack-plugin | SwcJsMinimizerRspackPlugin}.
+     * - Enable JavaScript code minification and register the {@link https://rspack.rs/plugins/rspack/swc-js-minimizer-rspack-plugin | SwcJsMinimizerRspackPlugin}.
      *
      * - Generated JavaScript and CSS filenames will have hash suffixes, see {@link Output.filenameHash}.
      *
@@ -442,7 +442,7 @@ export declare interface Config {
      * @defaultValue undefined
      *
      * @remarks
-     * Rspeedy use the plugin APIs from {@link https://rsbuild.dev/plugins/dev/index | Rsbuild}. See the corresponding document for developing a plugin.
+     * Rspeedy uses the plugin APIs from {@link https://rsbuild.rs/plugins/dev/index | Rsbuild}. See the corresponding document for developing a plugin.
      */
     plugins?: RsbuildPlugins | undefined;
 }
@@ -530,9 +530,9 @@ export declare interface CreateRspeedyOptions {
      */
     rspeedyConfig?: Config;
     /**
-     * Rspeedy automatically loads the .env file by default, utilizing the [Rsbuild API](https://rsbuild.dev/api/javascript-api/core#load-env-variables).
+     * Rspeedy automatically loads the .env file by default, utilizing the [Rsbuild API](https://rsbuild.rs/api/javascript-api/core#load-env-variables).
      * You can use the environment variables defined in the .env file within your code by accessing them via `import.meta.env.FOO` or `process.env.Foo`.
-     * @see https://rsbuild.dev/guide/advanced/env-vars#env-file
+     * @see https://rsbuild.rs/guide/advanced/env-vars#env-file
      * @defaultValue true
      */
     loadEnv?: CreateRsbuildOptions['loadEnv'];
@@ -540,7 +540,7 @@ export declare interface CreateRspeedyOptions {
      * Only build specified environments.
      * For example, passing `['lynx']` will only build the `lynx` environment.
      * If not specified or passing an empty array, all environments will be built.
-     * @see https://rsbuild.dev/guide/advanced/environments#build-specified-environment
+     * @see https://rsbuild.rs/guide/advanced/environments#build-specified-environment
      * @defaultValue []
      */
     environment?: CreateRsbuildOptions['environment'];
@@ -1127,7 +1127,7 @@ export declare interface Dev {
      *
      * During `rspeedy dev`, if this option is not set to `false`, the dev plugin normalizes it to `http://<detected-host>:<port>/` and appends `server.base` when configured.
      *
-     * The functionality of {@link Dev.assetPrefix} is basically the same as the {@link https://www.rspack.dev/config/output#outputpublicpath | output.publicPath}
+     * The functionality of {@link Dev.assetPrefix} is basically the same as the {@link https://rspack.rs/config/output#outputpublicpath | output.publicPath}
      * config in Rspack. With the following differences:
      *
      * - `dev.assetPrefix` only takes effect during development.
@@ -1478,7 +1478,7 @@ export declare type Entry = string | string[] | Record<string, string | string[]
  * The `EntryDescription` describes a entry. It is useful when the project has multiple entries with different configuration.
  *
  * @remarks
- * It is similar with the {@link https://www.rspack.dev/config/entry#entry-description-object | Entry Description Object} of Rspack.
+ * It is similar with the {@link https://rspack.rs/config/entry#entry-description-object | Entry Description Object} of Rspack.
  * But only a few properties that Lynx supports is allowed.
  *
  * @public
@@ -1501,7 +1501,7 @@ export declare interface EntryDescription {
 }
 
 /**
- * The exposed API of Rspeedy. Can be used in Rsbuild plugin with {@link https://rsbuild.dev/plugins/dev/core#apiuseexposed | api.useExposed}.
+ * The exposed API of Rspeedy. Can be used in Rsbuild plugin with {@link https://rsbuild.rs/plugins/dev/core#apiuseexposed | api.useExposed}.
  *
  * @public
  *
@@ -1835,7 +1835,7 @@ export { logger }
  *
  * @remarks
  *
- * This is actually an alias of {@link https://rsbuild.dev/api/javascript-api/core#mergersbuildconfig | mergeRsbuildConfig}.
+ * This is actually an alias of {@link https://rsbuild.rs/api/javascript-api/core#mergersbuildconfig | mergeRsbuildConfig}.
  *
  * @public
  */
@@ -1902,7 +1902,7 @@ export declare interface Minify {
      *
      * @remarks
      *
-     * For detailed configurations, please refer to {@link https://rspack.dev/plugins/rspack/swc-js-minimizer-rspack-plugin | SwcJsMinimizerRspackPlugin}.
+     * For detailed configurations, please refer to {@link https://rspack.rs/plugins/rspack/swc-js-minimizer-rspack-plugin | SwcJsMinimizerRspackPlugin}.
      *
      * @example
      *
@@ -1992,7 +1992,7 @@ export declare interface Output {
      *
      * @remarks
      *
-     * The functionality of {@link Output.assetPrefix} is basically the same as the {@link https://www.rspack.dev/config/output#outputpublicpath | output.publicPath}
+     * The functionality of {@link Output.assetPrefix} is basically the same as the {@link https://rspack.rs/config/output#outputpublicpath | output.publicPath}
      * config in Rspack. With the following differences:
      *
      * - `output.assetPrefix` only takes effect in the production build.
@@ -2016,6 +2016,12 @@ export declare interface Output {
     /**
      * The {@link Output.cleanDistPath} option determines whether all files in the output directory (default: `dist`) are removed before the build starts.
      *
+     * @remarks
+     *
+     * By default, if the output directory is a subdirectory of the project root path, Rspeedy will automatically clean all files in the build directory.
+     *
+     * When {@link https://rsbuild.rs/config/output/dist-path#root-directory | output.distPath.root} is an external directory or the same as the project root directory, `cleanDistPath` is not enabled by default to prevent accidental deletion of files from other directories.
+     *
      * @defaultValue Automatically enabled when `output.distPath.root` is a subdirectory of the project root; otherwise disabled.
      *
      * @example
@@ -2051,7 +2057,7 @@ export declare interface Output {
      *
      * @remarks
      *
-     * For more options, see {@link https://rspack.dev/plugins/rspack/copy-rspack-plugin | Rspack.CopyRspackPlugin}.
+     * For more options, see {@link https://rspack.rs/plugins/rspack/copy-rspack-plugin | Rspack.CopyRspackPlugin}.
      *
      * @example
      *
@@ -2197,7 +2203,7 @@ export declare interface Output {
      *
      * @remarks
      *
-     * More options can be found at {@link https://rsbuild.dev/config/output/dist-path | Rsbuild - distPath}.
+     * More options can be found at {@link https://rsbuild.rs/config/output/dist-path | Rsbuild - distPath}.
      *
      * @example
      *
@@ -2289,7 +2295,7 @@ export declare interface Output {
      *
      * @remarks
      *
-     * 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`).
+     * This is different with {@link https://rsbuild.rs/config/output/inline-scripts | output.inlineScripts } since we normally want to inline scripts in Lynx bundle (`.lynx.bundle`).
      *
      * There are two points that need to be especially noted:
      *
@@ -2407,7 +2413,7 @@ export declare interface Performance {
      */
     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.
+     * Whether capture timing information in the build time and the runtime, the same as the {@link https://rspack.rs/config/other-options#profile | profile} config of Rspack.
      *
      * @defaultValue Rspeedy sets this to `true` when `DEBUG` contains `rspeedy`; otherwise it leaves the option unset.
      *
@@ -2471,7 +2477,7 @@ export declare interface Performance {
      *
      * {@link Performance.printFileSize}
      *
-     * See {@link https://rsbuild.dev/config/performance/print-file-size | Rsbuild - performance.printFileSize} for details.
+     * See {@link https://rsbuild.rs/config/performance/print-file-size | Rsbuild - performance.printFileSize} for details.
      *
      * @example
      *
@@ -2801,7 +2807,7 @@ export declare interface Server {
      *
      * If you want to access lynx bundle through `http://<host>:<port>/foo/main.lynx.bundle`, you can change `server.base` to `/foo`
      *
-     * you can refer to {@link https://rsbuild.dev/config/server/base | server.base } for more information.
+     * you can refer to {@link https://rsbuild.rs/config/server/base | server.base } for more information.
      *
      * @example
      *
@@ -3012,7 +3018,7 @@ export declare interface Source {
      * Through the source.assetsInclude config, you can specify additional file types that should be treated as static assets.
      * These added static assets are processed using the same rules as the built-in supported static assets。
      *
-     * The usage of `source.assetsInclude` is consistent with {@link https://rspack.dev/config/module#condition | Condition}
+     * The usage of `source.assetsInclude` is consistent with {@link https://rspack.rs/config/module#condition | Condition}
      * in Rspack, which supports passing in strings, regular expressions, arrays of conditions, or logical conditions
      * to match the module path or assets.
      *
@@ -3208,7 +3214,7 @@ export declare interface Source {
      * By default, Rsbuild compiles JavaScript files in the current directory and TypeScript/JSX files
      * in all directories. Through the `source.exclude` config, you can specify files or directories
      * that should be excluded from compilation.
-     * The usage of `source.exclude` is consistent with {@link https://rspack.dev/config/module#ruleexclude | Rule.exclude}
+     * The usage of `source.exclude` is consistent with {@link https://rspack.rs/config/module#ruleexclude | Rule.exclude}
      * in Rspack, which supports passing in strings or regular expressions to match module paths.
      *
      * @example
@@ -3274,7 +3280,7 @@ export declare interface Source {
      *
      * Through the `source.include` config, you can specify directories or modules
      * that need to be compiled by Rsbuild.
-     * The usage of `source.include` is consistent with {@link https://rspack.dev/config/module#ruleinclude |  Rule.include}
+     * The usage of `source.include` is consistent with {@link https://rspack.rs/config/module#ruleinclude |  Rule.include}
      * in Rspack, which supports passing in strings or regular expressions to match the module path.
      *
      * @example
@@ -3346,7 +3352,7 @@ export declare interface Source {
      *
      * @remarks
      *
-     * See {@link https://rsbuild.dev/config/source/pre-entry | source.preEntry} for more details.
+     * See {@link https://rsbuild.rs/config/source/pre-entry | source.preEntry} for more details.
      *
      * @example
      *
@@ -3441,7 +3447,7 @@ export declare interface SourceMap {
      *
      * @remarks
      *
-     * See {@link https://rspack.dev/config/devtool | Rspack - Devtool} for details.
+     * See {@link https://rspack.rs/config/devtool | Rspack - Devtool} for details.
      *
      * @example
      *
@@ -3503,7 +3509,7 @@ export declare interface SourceMap {
  */
 export declare interface Tools {
     /**
-     * The {@link Tools.bundlerChain} changes the options of {@link https://www.rspack.dev | Rspack} using {@link https://github.com/rspack-contrib/rspack-chain | rspack-chain}.
+     * The {@link Tools.bundlerChain} changes the options of {@link https://rspack.rs | Rspack} using {@link https://github.com/rspack-contrib/rspack-chain | rspack-chain}.
      *
      * @defaultValue undefined
      *
@@ -3549,7 +3555,7 @@ export declare interface Tools {
      */
     cssLoader?: CssLoader | undefined;
     /**
-     * The {@link CssExtract} controls the options of {@link https://www.rspack.dev/plugins/rspack/css-extract-rspack-plugin | CssExtractRspackPlugin}
+     * The {@link CssExtract} controls the options of {@link https://rspack.rs/plugins/rspack/css-extract-rspack-plugin | CssExtractRspackPlugin}
      *
      * @defaultValue undefined
      */
@@ -3582,7 +3588,7 @@ export declare interface Tools {
      */
     rsdoctor?: RsdoctorRspackPluginOptions | undefined;
     /**
-     * The {@link Tools.rspack} controls the options of {@link https://www.rspack.dev/ | Rspack}.
+     * The {@link Tools.rspack} controls the options of {@link https://rspack.rs/ | Rspack}.
      *
      * @defaultValue undefined
      *
@@ -3604,7 +3610,7 @@ export declare interface Tools {
      * })
      * ```
      *
-     * See {@link https://www.rspack.dev/config/index | Rspack - Configuration} for details.
+     * See {@link https://rspack.rs/config/index | Rspack - Configuration} for details.
      *
      * @example
      *
@@ -3625,7 +3631,7 @@ export declare interface Tools {
      * })
      * ```
      *
-     * See {@link https://rsbuild.dev/config/tools/rspack#env | Rsbuild - tools.rspack} for details.
+     * See {@link https://rsbuild.rs/config/tools/rspack#env | Rsbuild - tools.rspack} for details.
      *
      * @example
      *
@@ -3647,7 +3653,7 @@ export declare interface Tools {
      * })
      * ```
      *
-     * See {@link https://rsbuild.dev/config/tools/rspack#mergeconfig | Rsbuild - tools.rspack} for details.
+     * See {@link https://rsbuild.rs/config/tools/rspack#mergeconfig | Rsbuild - tools.rspack} for details.
      *
      * @example
      *
@@ -3666,11 +3672,11 @@ export declare interface Tools {
      * })
      * ```
      *
-     * See {@link https://rsbuild.dev/config/tools/rspack#appendplugins | Rsbuild - tools.rspack} for details.
+     * See {@link https://rsbuild.rs/config/tools/rspack#appendplugins | Rsbuild - tools.rspack} for details.
      */
     rspack?: ToolsConfig['rspack'] | undefined;
     /**
-     * The {@link Tools.swc} controls the options of {@link https://rspack.dev/guide/features/builtin-swc-loader | builtin:swc-loader}.
+     * The {@link Tools.swc} controls the options of {@link https://rspack.rs/guide/features/builtin-swc-loader | builtin:swc-loader}.
      *
      * @defaultValue undefined
      */

package/dist/src_cli_main_ts.js

@@ -192,7 +192,7 @@ async function exit_onExit(signal) {
     await Promise.allSettled(exitPromises);
 }
 var package_namespaceObject = {
-    rE: "0.14.1"
+    rE: "0.14.2"
 };
 const version_version = package_namespaceObject.rE;
 const rspackVersion = rspack.rspackVersion;

package/dist/src_index_ts.js

@@ -374,7 +374,7 @@ function isDeno() {
     return false;
 }
 var package_namespaceObject = {
-    rE: "0.14.1"
+    rE: "0.14.2"
 };
 const version_version = package_namespaceObject.rE;
 const rspackVersion = rspack.rspackVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/rspeedy",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "A webpack/rspack-based frontend toolchain for Lynx",
   "keywords": [
     "webpack",
@@ -53,7 +53,7 @@
     "@rsdoctor/rspack-plugin": "1.2.3",
     "@lynx-js/cache-events-webpack-plugin": "^0.0.3",
     "@lynx-js/chunk-loading-webpack-plugin": "^0.3.3",
-    "@lynx-js/web-rsbuild-server-middleware": "0.20.1",
+    "@lynx-js/web-rsbuild-server-middleware": "0.20.2",
     "@lynx-js/webpack-dev-transport": "^0.2.0",
     "@lynx-js/websocket": "^0.0.4"
   },