Skip to content

feat: support inspect Rslib config #1255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2025
Merged

feat: support inspect Rslib config #1255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions packages/core/src/cli/inspect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ export async function inspect(
verbose: options.verbose,
outputPath: options.output,
writeToDisk: true,
extraConfigs: {
rslib: config,
},
});

return rsbuildInstance;
Expand Down
3 changes: 3 additions & 0 deletions tests/integration/cli/inspect/inspect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ describe('inspect command', async () => {
[
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.cjs.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.esm.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rslib.config.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.cjs.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.esm.mjs",
]
Expand Down Expand Up @@ -52,6 +53,7 @@ describe('inspect command', async () => {
expect(fileNames).toMatchInlineSnapshot(`
[
"<ROOT>/tests/integration/cli/inspect/dist/esm/.rsbuild/rsbuild.config.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/esm/.rsbuild/rslib.config.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/esm/.rsbuild/rspack.config.esm.mjs",
]
`);
Expand Down Expand Up @@ -85,6 +87,7 @@ describe('inspect command', async () => {
[
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.cjs.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.esm.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rslib.config.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.cjs.mjs",
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.esm.mjs",
]
Expand Down
3 changes: 3 additions & 0 deletions website/docs/en/guide/basic/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ When you run the command `npx rslib inspect` in the project root directory, the

- `rsbuild.config.mjs`: Represents the Rsbuild configuration used during the build.
- `rspack.config.web.mjs`: Represents the Rspack configuration used during the build.
- `rslib.config.mjs`: Represents the final Rslib configuration after normalization.

```text
➜ npx rslib inspect
Expand All @@ -87,6 +88,7 @@ Inspect config succeed, open following files to view the content:

- Rsbuild Config: /project/dist/.rsbuild/rsbuild.config.mjs
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
```

### Verbose content
Expand All @@ -110,6 +112,7 @@ Inspect config succeed, open following files to view the content:
- Rsbuild Config (cjs): /project/dist/.rsbuild/rsbuild.config.cjs.mjs
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
- Rspack Config (cjs): /project/dist/.rsbuild/rspack.config.cjs.mjs
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
```

## rslib mf-dev
Expand Down
2 changes: 2 additions & 0 deletions website/docs/en/guide/basic/configure-rslib.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,9 @@ Inspect config succeed, open following files to view the content:
- Rsbuild Config (cjs): /project/dist/.rsbuild/rsbuild.config.cjs.mjs
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
- Rspack Config (cjs): /project/dist/.rsbuild/rspack.config.cjs.mjs
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
```

- Open the generated `/dist/.rsbuild/rsbuild.config.esm.mjs` file to see the complete content of the Rsbuild config.
- Open the generated `/dist/.rsbuild/rspack.config.esm.mjs` file to see the complete content of the Rspack config.
- Open the generated `/dist/.rsbuild/rslib.config.mjs` file to see the complete content of the Rslib config.
3 changes: 3 additions & 0 deletions website/docs/zh/guide/basic/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Options:

- `rsbuild.config.mjs`: 表示在构建时使用的 Rsbuild 配置。
- `rspack.config.web.mjs`: 表示在构建时使用的 Rspack 配置。
- `rslib.config.mjs`: 表示归一化后的 Rslib 配置。

```text
➜ npx rslib inspect
Expand All @@ -87,6 +88,7 @@ Inspect config succeed, open following files to view the content:

- Rsbuild Config: /project/dist/.rsbuild/rsbuild.config.mjs
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
```

### 完整内容
Expand All @@ -110,6 +112,7 @@ Inspect config succeed, open following files to view the content:
- Rsbuild Config (cjs): /project/dist/.rsbuild/rsbuild.config.cjs.mjs
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
- Rspack Config (cjs): /project/dist/.rsbuild/rspack.config.cjs.mjs
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
```

## rslib mf-dev
Expand Down
2 changes: 2 additions & 0 deletions website/docs/zh/guide/basic/configure-rslib.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,9 @@ Inspect config succeed, open following files to view the content:
- Rsbuild Config (cjs): /project/dist/.rsbuild/rsbuild.config.cjs.mjs
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
- Rspack Config (cjs): /project/dist/.rsbuild/rspack.config.cjs.mjs
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
```

- 打开生成的 `/dist/.rsbuild/rsbuild.config.esm.mjs` 文件，即可查看 Rsbuild 配置的完整内容。
- 打开生成的 `/dist/.rsbuild/rspack.config.esm.mjs` 文件，即可查看 Rspack 配置的完整内容。
- 打开生成的 `/dist/.rsbuild/rslib.config.mjs` 文件，即可查看 Rslib 配置的完整内容。
Loading