Skip to content

Commit 8a762f2

Browse files
authored
feat: support inspect Rslib config (#1255)
1 parent 2a70a78 commit 8a762f2

File tree

6 files changed

+16
-0
lines changed

6 files changed

+16
-0
lines changed

packages/core/src/cli/inspect.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export async function inspect(
2727
verbose: options.verbose,
2828
outputPath: options.output,
2929
writeToDisk: true,
30+
extraConfigs: {
31+
rslib: config,
32+
},
3033
});
3134

3235
return rsbuildInstance;

tests/integration/cli/inspect/inspect.test.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ describe('inspect command', async () => {
1717
[
1818
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.cjs.mjs",
1919
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.esm.mjs",
20+
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rslib.config.mjs",
2021
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.cjs.mjs",
2122
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.esm.mjs",
2223
]
@@ -52,6 +53,7 @@ describe('inspect command', async () => {
5253
expect(fileNames).toMatchInlineSnapshot(`
5354
[
5455
"<ROOT>/tests/integration/cli/inspect/dist/esm/.rsbuild/rsbuild.config.mjs",
56+
"<ROOT>/tests/integration/cli/inspect/dist/esm/.rsbuild/rslib.config.mjs",
5557
"<ROOT>/tests/integration/cli/inspect/dist/esm/.rsbuild/rspack.config.esm.mjs",
5658
]
5759
`);
@@ -85,6 +87,7 @@ describe('inspect command', async () => {
8587
[
8688
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.cjs.mjs",
8789
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rsbuild.config.esm.mjs",
90+
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rslib.config.mjs",
8891
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.cjs.mjs",
8992
"<ROOT>/tests/integration/cli/inspect/dist/.rsbuild/rspack.config.esm.mjs",
9093
]

website/docs/en/guide/basic/cli.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ When you run the command `npx rslib inspect` in the project root directory, the
7979

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

8384
```text
8485
➜ npx rslib inspect
@@ -87,6 +88,7 @@ Inspect config succeed, open following files to view the content:
8788
8889
- Rsbuild Config: /project/dist/.rsbuild/rsbuild.config.mjs
8990
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
91+
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
9092
```
9193

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

115118
## rslib mf-dev

website/docs/en/guide/basic/configure-rslib.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,9 @@ Inspect config succeed, open following files to view the content:
222222
- Rsbuild Config (cjs): /project/dist/.rsbuild/rsbuild.config.cjs.mjs
223223
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
224224
- Rspack Config (cjs): /project/dist/.rsbuild/rspack.config.cjs.mjs
225+
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
225226
```
226227

227228
- Open the generated `/dist/.rsbuild/rsbuild.config.esm.mjs` file to see the complete content of the Rsbuild config.
228229
- Open the generated `/dist/.rsbuild/rspack.config.esm.mjs` file to see the complete content of the Rspack config.
230+
- Open the generated `/dist/.rsbuild/rslib.config.mjs` file to see the complete content of the Rslib config.

website/docs/zh/guide/basic/cli.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ Options:
7979

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

8384
```text
8485
➜ npx rslib inspect
@@ -87,6 +88,7 @@ Inspect config succeed, open following files to view the content:
8788
8889
- Rsbuild Config: /project/dist/.rsbuild/rsbuild.config.mjs
8990
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
91+
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
9092
```
9193

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

115118
## rslib mf-dev

website/docs/zh/guide/basic/configure-rslib.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,9 @@ Inspect config succeed, open following files to view the content:
222222
- Rsbuild Config (cjs): /project/dist/.rsbuild/rsbuild.config.cjs.mjs
223223
- Rspack Config (esm): /project/dist/.rsbuild/rspack.config.esm.mjs
224224
- Rspack Config (cjs): /project/dist/.rsbuild/rspack.config.cjs.mjs
225+
- Rslib Config: /project/dist/.rsbuild/rslib.config.mjs
225226
```
226227

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

0 commit comments

Comments
 (0)