diff --git a/docs/en/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md b/docs/en/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md index 6b970f644..6762ee273 100644 --- a/docs/en/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md +++ b/docs/en/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md @@ -16,7 +16,7 @@ schema?: CustomizedSchemaFn | undefined; ```js -import { pluginQRCode } from '@lynx-js/plugin-qrcode' +import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin' import { defineConfig } from '@lynx-js/rspeedy' export default defineConfig({ @@ -37,7 +37,7 @@ export default defineConfig({ You may press `a` in the terminal to switch between schemas. ```js -import { pluginQRCode } from '@lynx-js/plugin-qrcode' +import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin' import { defineConfig } from '@lynx-js/rspeedy' export default defineConfig({ diff --git a/docs/en/api/rspeedy/rspeedy.chunksplit.override.md b/docs/en/api/rspeedy/rspeedy.chunksplit.override.md index 0612df86b..1fb0a206c 100644 --- a/docs/en/api/rspeedy/rspeedy.chunksplit.override.md +++ b/docs/en/api/rspeedy/rspeedy.chunksplit.override.md @@ -32,7 +32,6 @@ export default defineConfig({ react: { test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/, name: 'lib-react', - chunks: 'all', }, }, }, diff --git a/docs/en/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md b/docs/en/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md index 428480f6a..25812971f 100644 --- a/docs/en/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md +++ b/docs/en/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md @@ -32,7 +32,6 @@ export default defineConfig({ react: { test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/, name: 'lib-react', - chunks: 'all', }, }, }, diff --git a/docs/en/api/rspeedy/rspeedy.output.inlinescripts.md b/docs/en/api/rspeedy/rspeedy.output.inlinescripts.md index 1a853f59c..f95e32676 100644 --- a/docs/en/api/rspeedy/rspeedy.output.inlinescripts.md +++ b/docs/en/api/rspeedy/rspeedy.output.inlinescripts.md @@ -9,16 +9,20 @@ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls wh **Signature:** ```typescript -inlineScripts?: boolean | undefined; +inlineScripts?: InlineChunkConfig | undefined; ``` ## Remarks -If no value is provided, the default value would be `true`. +If no value is provided, the default value would be `true`, which means all background thread scripts will be inlined. This is different with [output.inlineScripts](https://rsbuild.dev/config/output/inline-scripts) 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. +There are two points that need to be especially noted: + +1. Only background thread scripts can remain non-inlined, whereas the main thread script is always inlined. + +2. Currently, when `experimental_isLazyBundle` is enabled, `inlineScripts` will always be `true`. ## Example diff --git a/docs/en/api/rspeedy/rspeedy.output.md b/docs/en/api/rspeedy/rspeedy.output.md index d03960b7e..b669be89d 100644 --- a/docs/en/api/rspeedy/rspeedy.output.md +++ b/docs/en/api/rspeedy/rspeedy.output.md @@ -24,7 +24,7 @@ export interface Output | [distPath?](./rspeedy.output.distpath.md) | | [DistPath](./rspeedy.distpath.md) \| undefined | _(Optional)_ Set the directory of the dist files. | | [filename?](./rspeedy.output.filename.md) | | string \| [Filename](./rspeedy.filename.md) \| undefined | _(Optional)_ The [Filename](./rspeedy.filename.md) determines the name of the JavaScript bundle file to be output. These bundles will be written to the directory specified by output.path. | | [filenameHash?](./rspeedy.output.filenamehash.md) | | boolean \| string \| undefined | _(Optional)_ The [Output.filenameHash](./rspeedy.output.filenamehash.md) option controls whether to add a hash value to the filename after the production build. | -| [inlineScripts?](./rspeedy.output.inlinescripts.md) | | boolean \| undefined | _(Optional)_ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls whether to inline scripts into Lynx bundle (.lynx.bundle). | +| [inlineScripts?](./rspeedy.output.inlinescripts.md) | | InlineChunkConfig \| undefined | _(Optional)_ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls whether to inline scripts into Lynx bundle (.lynx.bundle). | | [legalComments?](./rspeedy.output.legalcomments.md) | | 'none' \| 'inline' \| 'linked' \| undefined | _(Optional)_ The [Output.legalComments](./rspeedy.output.legalcomments.md) controls how to handle the legal comment. | | [minify?](./rspeedy.output.minify.md) | | [Minify](./rspeedy.minify.md) \| boolean \| undefined | _(Optional)_ The [Minify](./rspeedy.minify.md) configures whether to enable code minification in the production build, or to configure minimizer options. | | [sourceMap?](./rspeedy.output.sourcemap.md) | | boolean \| [SourceMap](./rspeedy.sourcemap.md) \| undefined | _(Optional)_ The [SourceMap](./rspeedy.sourcemap.md) configures whether and how to generate source-map for outputs. | diff --git a/docs/zh/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md b/docs/zh/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md index 6b970f644..6762ee273 100644 --- a/docs/zh/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md +++ b/docs/zh/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcodeoptions.schema.md @@ -16,7 +16,7 @@ schema?: CustomizedSchemaFn | undefined; ```js -import { pluginQRCode } from '@lynx-js/plugin-qrcode' +import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin' import { defineConfig } from '@lynx-js/rspeedy' export default defineConfig({ @@ -37,7 +37,7 @@ export default defineConfig({ You may press `a` in the terminal to switch between schemas. ```js -import { pluginQRCode } from '@lynx-js/plugin-qrcode' +import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin' import { defineConfig } from '@lynx-js/rspeedy' export default defineConfig({ diff --git a/docs/zh/api/rspeedy/rspeedy.chunksplit.override.md b/docs/zh/api/rspeedy/rspeedy.chunksplit.override.md index 0612df86b..1fb0a206c 100644 --- a/docs/zh/api/rspeedy/rspeedy.chunksplit.override.md +++ b/docs/zh/api/rspeedy/rspeedy.chunksplit.override.md @@ -32,7 +32,6 @@ export default defineConfig({ react: { test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/, name: 'lib-react', - chunks: 'all', }, }, }, diff --git a/docs/zh/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md b/docs/zh/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md index 428480f6a..25812971f 100644 --- a/docs/zh/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md +++ b/docs/zh/api/rspeedy/rspeedy.chunksplitcustom.splitchunks.md @@ -32,7 +32,6 @@ export default defineConfig({ react: { test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/, name: 'lib-react', - chunks: 'all', }, }, }, diff --git a/docs/zh/api/rspeedy/rspeedy.output.inlinescripts.md b/docs/zh/api/rspeedy/rspeedy.output.inlinescripts.md index 1a853f59c..f95e32676 100644 --- a/docs/zh/api/rspeedy/rspeedy.output.inlinescripts.md +++ b/docs/zh/api/rspeedy/rspeedy.output.inlinescripts.md @@ -9,16 +9,20 @@ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls wh **Signature:** ```typescript -inlineScripts?: boolean | undefined; +inlineScripts?: InlineChunkConfig | undefined; ``` ## Remarks -If no value is provided, the default value would be `true`. +If no value is provided, the default value would be `true`, which means all background thread scripts will be inlined. This is different with [output.inlineScripts](https://rsbuild.dev/config/output/inline-scripts) 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. +There are two points that need to be especially noted: + +1. Only background thread scripts can remain non-inlined, whereas the main thread script is always inlined. + +2. Currently, when `experimental_isLazyBundle` is enabled, `inlineScripts` will always be `true`. ## Example diff --git a/docs/zh/api/rspeedy/rspeedy.output.md b/docs/zh/api/rspeedy/rspeedy.output.md index d03960b7e..b669be89d 100644 --- a/docs/zh/api/rspeedy/rspeedy.output.md +++ b/docs/zh/api/rspeedy/rspeedy.output.md @@ -24,7 +24,7 @@ export interface Output | [distPath?](./rspeedy.output.distpath.md) | | [DistPath](./rspeedy.distpath.md) \| undefined | _(Optional)_ Set the directory of the dist files. | | [filename?](./rspeedy.output.filename.md) | | string \| [Filename](./rspeedy.filename.md) \| undefined | _(Optional)_ The [Filename](./rspeedy.filename.md) determines the name of the JavaScript bundle file to be output. These bundles will be written to the directory specified by output.path. | | [filenameHash?](./rspeedy.output.filenamehash.md) | | boolean \| string \| undefined | _(Optional)_ The [Output.filenameHash](./rspeedy.output.filenamehash.md) option controls whether to add a hash value to the filename after the production build. | -| [inlineScripts?](./rspeedy.output.inlinescripts.md) | | boolean \| undefined | _(Optional)_ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls whether to inline scripts into Lynx bundle (.lynx.bundle). | +| [inlineScripts?](./rspeedy.output.inlinescripts.md) | | InlineChunkConfig \| undefined | _(Optional)_ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls whether to inline scripts into Lynx bundle (.lynx.bundle). | | [legalComments?](./rspeedy.output.legalcomments.md) | | 'none' \| 'inline' \| 'linked' \| undefined | _(Optional)_ The [Output.legalComments](./rspeedy.output.legalcomments.md) controls how to handle the legal comment. | | [minify?](./rspeedy.output.minify.md) | | [Minify](./rspeedy.minify.md) \| boolean \| undefined | _(Optional)_ The [Minify](./rspeedy.minify.md) configures whether to enable code minification in the production build, or to configure minimizer options. | | [sourceMap?](./rspeedy.output.sourcemap.md) | | boolean \| [SourceMap](./rspeedy.sourcemap.md) \| undefined | _(Optional)_ The [SourceMap](./rspeedy.sourcemap.md) configures whether and how to generate source-map for outputs. | diff --git a/docs/zh/api/rspeedy/rspeedy.source.tsconfigpath.md b/docs/zh/api/rspeedy/rspeedy.source.tsconfigpath.md index f97c217d5..4213a4449 100644 --- a/docs/zh/api/rspeedy/rspeedy.source.tsconfigpath.md +++ b/docs/zh/api/rspeedy/rspeedy.source.tsconfigpath.md @@ -18,7 +18,7 @@ The `tsconfigPath` configuration affects the following behaviors: - The `paths` field is used to configure [Path Aliases](./rspeedy.source.alias.md). -- Sets the scope and rules for the [Type Check Plugin](https://rsbuild.rs/zh/guide/basic/typescript#%E7%B1%BB%E5%9E%8B%E6%A3%80%E6%9F%A5). +- Sets the scope and rules for the [Type Check Plugin](https://rsbuild.rs/guide/basic/typescript#type-checking). ## Example