@rsdoctor/docs 1.2.4-beta.0 → 1.2.4-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/docs/en/{_meta.json → _nav.json} +5 -0
  2. package/docs/en/config/options/_meta.json +13 -1
  3. package/docs/en/config/options/brief.mdx +35 -0
  4. package/docs/en/config/options/disableClientServer.mdx +11 -0
  5. package/docs/en/config/options/experiments.mdx +21 -0
  6. package/docs/en/config/options/features.mdx +70 -0
  7. package/docs/en/config/options/mode.mdx +20 -0
  8. package/docs/en/config/options/options-v2.mdx +40 -0
  9. package/docs/en/config/options/options.mdx +61 -266
  10. package/docs/en/config/options/output.mdx +162 -0
  11. package/docs/en/config/options/port.mdx +7 -0
  12. package/docs/en/config/options/supports.mdx +72 -0
  13. package/docs/en/config/options/term.mdx +36 -3
  14. package/docs/en/guide/rules/rule-custom.mdx +1 -11
  15. package/docs/en/guide/start/cli.mdx +5 -5
  16. package/docs/en/guide/start/quick-start-shared.mdx +1 -1
  17. package/docs/en/guide/usage/module-analysis.mdx +1 -2
  18. package/docs/en/shared/mode-intro.md +2 -1
  19. package/docs/public/netlify.toml +12 -0
  20. package/docs/zh/{_meta.json → _nav.json} +5 -0
  21. package/docs/zh/config/options/_meta.json +13 -1
  22. package/docs/zh/config/options/brief.mdx +35 -0
  23. package/docs/zh/config/options/disableClientServer.mdx +11 -0
  24. package/docs/zh/config/options/experiments.mdx +21 -0
  25. package/docs/zh/config/options/features.mdx +70 -0
  26. package/docs/zh/config/options/mode.mdx +20 -0
  27. package/docs/zh/config/options/options-v2.mdx +40 -0
  28. package/docs/zh/config/options/options.mdx +61 -265
  29. package/docs/zh/config/options/output.mdx +162 -0
  30. package/docs/zh/config/options/port.mdx +7 -0
  31. package/docs/zh/config/options/supports.mdx +71 -0
  32. package/docs/zh/config/options/term.mdx +33 -0
  33. package/docs/zh/guide/rules/rule-custom.mdx +1 -11
  34. package/docs/zh/guide/start/cli.mdx +5 -5
  35. package/docs/zh/guide/start/quick-start-shared.mdx +1 -1
  36. package/docs/zh/guide/usage/module-analysis.mdx +1 -2
  37. package/docs/zh/shared/mode-intro.md +1 -0
  38. package/package.json +15 -13
@@ -73,7 +73,7 @@ export default {
73
73
 
74
74
  import { PackageManagerTabs } from '@theme';
75
75
 
76
- import { Tab, Tabs } from 'rspress/theme';
76
+ import { Tab, Tabs } from '@rspress/core/theme';
77
77
 
78
78
  <PackageManagerTabs command="add @rsdoctor/core -D" />
79
79
 
@@ -200,19 +200,15 @@ const CheckRule = defineRule<typeof ruleTitle, config>(() => ({
200
200
  [LinkRule Type](#linkrulestoredata)
201
201
 
202
202
  - 组件输入
203
-
204
203
  - type
205
-
206
204
  - 使用组件类型。
207
205
  - value: 'link'。
208
206
 
209
207
  - title
210
-
211
208
  - 规则标题。
212
209
  - type: string。
213
210
 
214
211
  - description
215
-
216
212
  - 规则描述。数据来源为 report 中的 message 或 detail.description:
217
213
  ```js
218
214
  report({
@@ -226,7 +222,6 @@ const CheckRule = defineRule<typeof ruleTitle, config>(() => ({
226
222
  - type: string。
227
223
 
228
224
  - level
229
-
230
225
  - 规则级别。
231
226
  - type:warn | error。
232
227
 
@@ -267,19 +262,15 @@ report({
267
262
  [CodeViewRule Type](#codeviewrule)
268
263
 
269
264
  - 组件输入
270
-
271
265
  - type
272
-
273
266
  - 使用组件类型。
274
267
  - value: 'code-view'。
275
268
 
276
269
  - title
277
-
278
270
  - 规则标题。
279
271
  - type: string。
280
272
 
281
273
  - description
282
-
283
274
  - 规则描述。数据来源为 report 中的 message 或 detail.description:
284
275
  ```js
285
276
  report({
@@ -293,7 +284,6 @@ report({
293
284
  - type: string。
294
285
 
295
286
  - level
296
-
297
287
  - 规则级别。
298
288
  - type:warn | error。
299
289
 
@@ -17,7 +17,7 @@
17
17
 
18
18
  import { PackageManagerTabs } from '@theme';
19
19
 
20
- import { Tab, Tabs } from 'rspress/theme';
20
+ import { Tab, Tabs } from '@rspress/core/theme';
21
21
 
22
22
  <PackageManagerTabs command="add @rsdoctor/cli -D" />
23
23
 
@@ -76,18 +76,18 @@ rsdoctor bundle-diff --baseline="baseline/.rsdoctor/manifest.json" --current="cu
76
76
 
77
77
  <Tabs>
78
78
 
79
- <Tab label="cjs">
79
+ <Tab label="esm">
80
80
 
81
81
  ```js
82
- const { execute } = require('@rsdoctor/cli');
82
+ import { execute } from '@rsdoctor/cli';
83
83
  ```
84
84
 
85
85
  </Tab>
86
86
 
87
- <Tab label="esm">
87
+ <Tab label="cjs">
88
88
 
89
89
  ```js
90
- import { execute } from '@rsdoctor/cli';
90
+ const { execute } = require('@rsdoctor/cli');
91
91
  ```
92
92
 
93
93
  </Tab>
@@ -84,7 +84,7 @@ export default {
84
84
 
85
85
  在 `next.config.ts` 的 [Rspack 配置](https://rspack.rs/guide/tech/next)([webpack 配置](https://nextjs.org/docs/pages/api-reference/config/next-config-js/webpack)) 中初始化 [RsdoctorRspackPlugin](#rspack-%E9%A1%B9%E7%9B%AE)([RsdoctorWebpackPlugin](#webpack-%E9%A1%B9%E7%9B%AE)) 插件。
86
86
 
87
- import { Tab, Tabs } from 'rspress/theme';
87
+ import { Tab, Tabs } from '@rspress/core/theme';
88
88
 
89
89
  <Tabs>
90
90
  <Tab label="Rspack">
@@ -48,9 +48,8 @@
48
48
  - `Usage` 标签会展示各种模块标签的作用。
49
49
 
50
50
  - `Concatenated`标签:
51
-
52
51
  - `Concatenated` 标签标识该模块是被串联的子模块,`hover` 上去就可以看到被聚合到了哪个主模块中。这种聚合模块无法继续拆解打包后的代码,因此无法得知具体的 `Bundled Size`,只能得知整个串联模块的大小。
53
- - 名词解释:串联模块是将多个模块在打包时提升或串联到一个闭包中。 `Concatenated Module` 的解释可以查看[名词解释](guide/usage/bundle-size#%E5%90%8D%E8%AF%8D%E8%A7%A3%E9%87%8A)。
52
+ - 名词解释:串联模块是将多个模块在打包时提升或串联到一个闭包中。 `Concatenated Module` 的解释可以查看[名词解释](/guide/usage/bundle-size#%E5%90%8D%E8%AF%8D%E8%A7%A3%E9%87%8A)。
54
53
 
55
54
  - `!` 标签,`hover` 上去可以展示模块详细路径.
56
55
 
@@ -3,3 +3,4 @@
3
3
  - **brief 模式:** 在构建产物目录的 `.rsdoctor` 文件夹中生成一个 HTML 报告文件,所有构建分析数据会整合注入到这个 HTML 文件中,可以通过浏览器打开该 HTML 文件查看报告。brief 模式还有更多配置项,详细信息请参阅:[brief](/config/options/options#brief).
4
4
 
5
5
  - **lite 模式:** 基于普通模式,不展示源码和产物代码,仅显示打包后的代码信息。
6
+ - lite 模式即将在 V2 废弃,参考 [lite 模式废弃说明](/config/options/options-v2#lite)。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rsdoctor/docs",
3
- "version": "1.2.4-beta.0",
3
+ "version": "1.2.4-beta.1",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -18,30 +18,32 @@
18
18
  "registry": "https://registry.npmjs.org/"
19
19
  },
20
20
  "devDependencies": {
21
- "@rspress/plugin-algolia": "2.0.0-beta.20",
22
- "@rspress/plugin-llms": "2.0.0-beta.20",
23
- "@rspress/plugin-rss": "2.0.0-beta.6",
21
+ "@rspress/plugin-algolia": "2.0.0-beta.29",
22
+ "@rspress/plugin-llms": "2.0.0-beta.29",
23
+ "@rspress/plugin-rss": "2.0.0-beta.29",
24
24
  "@types/node": "^22.8.1",
25
- "@types/react": "^18.3.23",
25
+ "@types/react": "^18.3.24",
26
26
  "@types/react-dom": "^18.3.7",
27
+ "cross-env": "^7.0.3",
27
28
  "react": "18.3.1",
28
29
  "react-dom": "18.3.1",
29
- "rsbuild-plugin-google-analytics": "^1.0.3",
30
- "rsbuild-plugin-open-graph": "^1.0.2",
31
- "rspress-plugin-font-open-sans": "^1.0.0",
30
+ "rsbuild-plugin-google-analytics": "^1.0.4",
31
+ "rsbuild-plugin-open-graph": "^1.1.0",
32
+ "rspress-plugin-font-open-sans": "^1.0.3",
32
33
  "rspress-plugin-sitemap": "^1.1.4",
33
34
  "typescript": "^5.9.2",
34
- "@rsbuild/plugin-sass": "^1.3.3",
35
- "@rsdoctor/types": "1.2.4-beta.0"
35
+ "@rsbuild/plugin-sass": "^1.4.0",
36
+ "@rsdoctor/types": "1.2.4-beta.1"
36
37
  },
37
38
  "dependencies": {
38
39
  "@rstack-dev/doc-ui": "1.11.0",
40
+ "clsx": "^2.1.1",
39
41
  "react-markdown": "^9.1.0",
40
- "rspress": "2.0.0-beta.6"
42
+ "@rspress/core": "2.0.0-beta.29"
41
43
  },
42
44
  "scripts": {
43
- "dev": "rspress dev",
44
- "build": "rspress build",
45
+ "dev": "cross-env RSPRESS_PERSIST_CACHE=false rspress dev",
46
+ "build": "cross-env RSPRESS_PERSIST_CACHE=false rspress build && sh build.sh",
45
47
  "preview": "rspress preview"
46
48
  }
47
49
  }