@rsdoctor/docs 1.0.0-beta.2 → 1.0.0-rc.0

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 (55) hide show
  1. package/README.md +1 -1
  2. package/docs/en/blog/release/release-note-0_1.mdx +8 -12
  3. package/docs/en/blog/release/release-note-0_3.mdx +2 -2
  4. package/docs/en/blog/release/release-note-0_4.mdx +4 -4
  5. package/docs/en/blog/topic/duplicate-pkg-problem.mdx +12 -13
  6. package/docs/en/blog/topic/loader-optimization.mdx +6 -6
  7. package/docs/en/config/options/options.mdx +53 -22
  8. package/docs/en/guide/more/faq.mdx +3 -3
  9. package/docs/en/guide/rules/rule-custom.mdx +3 -9
  10. package/docs/en/guide/rules/rules.mdx +22 -25
  11. package/docs/en/guide/start/cli.mdx +1 -1
  12. package/docs/en/guide/start/intro.mdx +16 -23
  13. package/docs/en/guide/start/quick-start-shared.mdx +2 -2
  14. package/docs/en/guide/start/quick-start.mdx +3 -3
  15. package/docs/en/guide/usage/bundle-alerts.mdx +2 -2
  16. package/docs/en/guide/usage/bundle-diff.mdx +9 -9
  17. package/docs/en/guide/usage/bundle-overall.mdx +3 -3
  18. package/docs/en/guide/usage/bundle-size.mdx +33 -17
  19. package/docs/en/guide/usage/compile-alerts.mdx +2 -2
  20. package/docs/en/guide/usage/compile-overall.mdx +13 -13
  21. package/docs/en/guide/usage/loaders-analysis.mdx +6 -6
  22. package/docs/en/guide/usage/loaders-timeline.mdx +5 -5
  23. package/docs/en/guide/usage/module-analysis.mdx +4 -4
  24. package/docs/en/guide/usage/plugins-analysis.mdx +2 -2
  25. package/docs/en/guide/usage/project-overall.mdx +4 -4
  26. package/docs/en/guide/usage/resolver.mdx +1 -1
  27. package/docs/en/guide/usage/rule-config.mdx +5 -5
  28. package/docs/zh/blog/release/release-note-0_1.mdx +8 -14
  29. package/docs/zh/blog/release/release-note-0_3.mdx +2 -2
  30. package/docs/zh/blog/release/release-note-0_4.mdx +4 -4
  31. package/docs/zh/blog/topic/duplicate-pkg-problem.mdx +10 -11
  32. package/docs/zh/blog/topic/loader-optimization.mdx +6 -6
  33. package/docs/zh/config/options/options.mdx +111 -82
  34. package/docs/zh/guide/more/faq.mdx +3 -3
  35. package/docs/zh/guide/rules/rule-custom.mdx +3 -9
  36. package/docs/zh/guide/rules/rules.mdx +11 -17
  37. package/docs/zh/guide/start/cli.mdx +1 -1
  38. package/docs/zh/guide/start/intro.mdx +9 -17
  39. package/docs/zh/guide/start/quick-start.mdx +2 -2
  40. package/docs/zh/guide/usage/bundle-alerts.mdx +1 -1
  41. package/docs/zh/guide/usage/bundle-diff.mdx +9 -9
  42. package/docs/zh/guide/usage/bundle-overall.mdx +3 -3
  43. package/docs/zh/guide/usage/bundle-size.mdx +25 -18
  44. package/docs/zh/guide/usage/compile-alerts.mdx +1 -1
  45. package/docs/zh/guide/usage/compile-overall.mdx +13 -13
  46. package/docs/zh/guide/usage/loaders-analysis.mdx +6 -6
  47. package/docs/zh/guide/usage/loaders-timeline.mdx +5 -5
  48. package/docs/zh/guide/usage/module-analysis.mdx +5 -4
  49. package/docs/zh/guide/usage/plugins-analysis.mdx +2 -2
  50. package/docs/zh/guide/usage/project-overall.mdx +4 -4
  51. package/docs/zh/guide/usage/resolver.mdx +1 -1
  52. package/docs/zh/guide/usage/rule-config.mdx +2 -2
  53. package/package.json +2 -2
  54. package/docs/public/bundle-alerts.png +0 -0
  55. package/docs/public/cross-chunks-package.png +0 -0
package/docs/zh/guide/usage/module-analysis.mdx CHANGED
@@ -7,7 +7,7 @@
7
7
  在该模块中，可以分析 `Module` 引用链，如果有拆包诉求或者想要看某个 `Module` 为何被引入，可以通过 `Module 引用链分析` 快速清晰的定位引用链。
8
8
 
9
9
  <img
10
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/module-analysis-tree.png"
10
+ src="https://assets.rspack.dev/others/assets/rsdoctor/module-analysis-tree.png"
11
11
  width="600px"
12
12
  style={{ margin: 'auto' }}
13
13
  />
@@ -17,8 +17,9 @@
17
17
  `「Bundle Size」` 页面中点击某个 **Assets** 后右侧会显示 `「Module 树」`，**Module** 后面会有跟着如下红框内图标，点击即可查看该 **Module** 的引用链关系图。
18
18
 
19
19
  {' '}
20
+
20
21
  <img
21
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/module-analysis-entry.png"
22
+ src="https://assets.rspack.dev/others/assets/rsdoctor/module-analysis-entry.png"
22
23
  height="300px"
23
24
  width="440px"
24
25
  style={{ margin: 'auto' }}
@@ -38,7 +39,7 @@
38
39
  - **依赖链树的父子关系**：父节点文件是被子节点文件所依赖，进而被打包到产物中的。同理，孙子节点文件是被子节点所依赖而打包到产物中的，依次类推。
39
40
 
40
41
  <img
41
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/module-analysis-jump-icon.png"
42
+ src="https://assets.rspack.dev/others/assets/rsdoctor/module-analysis-jump-icon.png"
42
43
  width="700px"
43
44
  style={{ margin: 'auto' }}
44
45
  />
@@ -53,7 +54,7 @@
53
54
  - `!` 标签，`hover` 上去可以展示模块详细路径.
54
55
 
55
56
  <img
56
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/module-analysis-icons.png"
57
+ src="https://assets.rspack.dev/others/assets/rsdoctor/module-analysis-icons.png"
57
58
  width="600px"
58
59
  style={{ margin: 'auto' }}
59
60
  />
package/docs/zh/guide/usage/plugins-analysis.mdx CHANGED
@@ -5,7 +5,7 @@
5
5
  我们在 **Rsdoctor** 内 `Compile Analysis` 的二级页面 `Plugins Analysis` 中，可以看到当前 Rspack 或 Webpack 项目中所有被插件使用过的 **Compiler Hooks** 以及 **Compilation Hooks** 的调用数据信息，其内容如下图所示：
6
6
 
7
7
  <img
8
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/plugins-analysis-overall.png"
8
+ src="https://assets.rspack.dev/others/assets/rsdoctor/plugins-analysis-overall.png"
9
9
  width={'600px'}
10
10
  style={{ margin: 'auto' }}
11
11
  />
@@ -32,7 +32,7 @@ plugin 耗时中会计算 Rsdoctor 的内部插件耗时。
32
32
  如果我们需要查看项目的 Rspack 或 Webpack 配置，则可以通过点击卡片右上角的 `View Bundler Config`，页面会弹出一个浮层，其中包含被序列化后的 **Bundler Config**，如下图所示：
33
33
 
34
34
  <img
35
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/plugins-analysis-config.png"
35
+ src="https://assets.rspack.dev/others/assets/rsdoctor/plugins-analysis-config.png"
36
36
  width={'400px'}
37
37
  style={{ margin: 'auto' }}
38
38
  />
package/docs/zh/guide/usage/project-overall.mdx CHANGED
@@ -5,7 +5,7 @@
5
5
  我们在启动 **Rsdoctor** 的主界面中，会看到名为 `Project Overall` 的一个卡片，可以通过它了解到当前项目**配置、版本、规则预警**的信息，其内容如下图所示：
6
6
 
7
7
  <img
8
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/project-overall-1.jpg"
8
+ src="https://assets.rspack.dev/others/assets/rsdoctor/project-overall-1.jpg"
9
9
  width="400px"
10
10
  height="600px"
11
11
  style={{ margin: 'auto' }}
@@ -18,7 +18,7 @@
18
18
  | <b><i>errors</i></b> | 代表 Rsdoctor 在当次运行中检测出的 **error** 级别的规则 |
19
19
  | <b><i>warns</i></b> | 代表 Rsdoctor 在当次运行中检测出的 **warn** 级别的规则 |
20
20
  | <b><i>webpack</i></b> | 代表当次运行时获取到的 Webpack 版本 |
21
- | <b><i>cwd</i></b> | 代表当次运行时的进程执行目录，即 [process.cwd()](https://nodejs.org/dist/latest-v18.x/docs/api/process.html#processcwd) |
21
+ | <b><i>cwd</i></b> | 代表当次运行时的进程执行目录，即 [process.cwd()](https://nodejs.org/dist/latest-v22.x/docs/api/process.html#processcwd) |
22
22
  | <b><i>cpu</i></b> | 代表 cpu 信息 |
23
23
  | <b><i>memory</i></b> | 代表当次运行时的 memory 信息 |
24
24
  | <b><i>node</i></b> | 代表 [Node.js](https://nodejs.org/) 版本号 |
@@ -33,7 +33,7 @@
33
33
  如果我们需要查看项目的 Rspack 或 Webpack 配置，则可以通过点击卡片右上角的 `View Bundler Config`，页面会弹出一个浮层，其中包含被序列化后的 [Bundler Config](https://webpack.js.org/configuration/)，如下图所示：
34
34
 
35
35
  <img
36
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/project-overall-config.jpg"
36
+ src="https://assets.rspack.dev/others/assets/rsdoctor/project-overall-config.jpg"
37
37
  width="500px"
38
38
  style={{ margin: 'auto' }}
39
39
  />
@@ -43,7 +43,7 @@
43
43
  卡片中的 `errors` 与 `warns` 如果显示的数字大于 0，则可以点击来查看对应的详情列表，下图以 `warns` 为例：
44
44
 
45
45
  <img
46
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/overall/project-overall-warning.jpg"
46
+ src="https://assets.rspack.dev/others/assets/rsdoctor/bundle-alerts.png"
47
47
  width="500px"
48
48
  style={{ margin: 'auto' }}
49
49
  />
package/docs/zh/guide/usage/resolver.mdx CHANGED
@@ -19,7 +19,7 @@ new rsdoctorRspackPlugin({
19
19
 
20
20
  我们在 **Rsdoctor** 内 `Module Resolve` 中，可以看到当前 Webpack 项目中的所有源文件，通过**点击某个文件**可以查看该文件中引入的**模块路径**、**解析前后的路径对比**、**解析耗时**等信息，其内容如下图所示：
21
21
 
22
- <img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/resolver.png" />
22
+ <img src="https://assets.rspack.dev/others/assets/rsdoctor/resolver.png" />
23
23
 
24
24
  ## 名词释义
25
25
 
package/docs/zh/guide/usage/rule-config.mdx CHANGED
@@ -7,13 +7,13 @@
7
7
  <img
8
8
  width="700"
9
9
  style={{ margin: '10px auto' }}
10
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/rule-config-cli.png"
10
+ src="https://assets.rspack.dev/others/assets/rsdoctor/rule-config-cli.png"
11
11
  />
12
12
 
13
13
  <img
14
14
  width="700"
15
15
  style={{ margin: '10px auto' }}
16
- src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/rule-config-1.png"
16
+ src="https://assets.rspack.dev/others/assets/rsdoctor/bundle-alerts.png"
17
17
  />
18
18
 
19
19
  ## 如何使用
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rsdoctor/docs",
3
- "version": "1.0.0-beta.2",
3
+ "version": "1.0.0-rc.0",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -30,7 +30,7 @@
30
30
  "rspress-plugin-font-open-sans": "^1.0.0",
31
31
  "rspress-plugin-sitemap": "^1.1.1",
32
32
  "typescript": "^5.2.2",
33
- "@rsdoctor/types": "1.0.0-beta.2"
33
+ "@rsdoctor/types": "1.0.0-rc.0"
34
34
  },
35
35
  "dependencies": {
36
36
  "@rstack-dev/doc-ui": "1.7.2",
package/docs/public/bundle-alerts.png DELETED
Binary file