Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand All @@ -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({
Expand Down
1 change: 0 additions & 1 deletion docs/en/api/rspeedy/rspeedy.chunksplit.override.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export default defineConfig({
react: {
test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/,
name: 'lib-react',
chunks: 'all',
},
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export default defineConfig({
react: {
test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/,
name: 'lib-react',
chunks: 'all',
},
},
},
Expand Down
10 changes: 7 additions & 3 deletions docs/en/api/rspeedy/rspeedy.output.inlinescripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/en/api/rspeedy/rspeedy.output.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<code>.lynx.bundle</code>). |
| [inlineScripts?](./rspeedy.output.inlinescripts.md) | | InlineChunkConfig \| undefined | _(Optional)_ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls whether to inline scripts into Lynx bundle (<code>.lynx.bundle</code>). |
| [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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand All @@ -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({
Expand Down
1 change: 0 additions & 1 deletion docs/zh/api/rspeedy/rspeedy.chunksplit.override.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export default defineConfig({
react: {
test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/,
name: 'lib-react',
chunks: 'all',
},
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export default defineConfig({
react: {
test: /node_modules[\\/](@lynx-js[\\/]react|react-router)[\\/]/,
name: 'lib-react',
chunks: 'all',
},
},
},
Expand Down
10 changes: 7 additions & 3 deletions docs/zh/api/rspeedy/rspeedy.output.inlinescripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/api/rspeedy/rspeedy.output.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<code>.lynx.bundle</code>). |
| [inlineScripts?](./rspeedy.output.inlinescripts.md) | | InlineChunkConfig \| undefined | _(Optional)_ The [Output.inlineScripts](./rspeedy.output.inlinescripts.md) option controls whether to inline scripts into Lynx bundle (<code>.lynx.bundle</code>). |
| [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. |
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/api/rspeedy/rspeedy.source.tsconfigpath.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down