@rsdoctor/docs 1.2.3 → 1.2.4-beta.1

package/docs/zh/config/options/port.mdx

@@ -0,0 +1,7 @@
+# port
+
+- **类型：** `number`
+- **可选：** `true`
+- **默认值：** `random(3000, 8999)`
+
+配置 Rsdoctor 服务的端口。

package/docs/zh/config/options/supports.mdx

@@ -0,0 +1,71 @@
+import { Badge } from '@theme';
+
+# supports
+
+- **类型：** [Supports Types](#supports-types)
+- **可选：** `true`
+- **默认值：** `undefined`
+
+该选项是配置 Rsdoctor 是否开启某些细节特性分析能力支持的，例如：是否开启对 BannerPlugin 的兼容能力。
+
+## supportsTypes
+
+```ts
+type ISupport = {
+  banner?: boolean;
+  parseBundle?: boolean;
+  generateTileGraph?: boolean;
+};
+```
+
+## banner
+
+:::danger
+`supports.banner` 分析仅用于调试，请勿将其用于生产。
+:::
+
+- **类型：** `boolean`
+- **默认值：** `true`
+
+如果开启 `supports.banner` 则会开启 Rsdoctor 对 BannerPlugin 的兼容逻辑。详细请看：[支持 BannerPlugin](../../guide/usage/bundle-size#%E6%94%AF%E6%8C%81-bannerplugin)
+
+## ~~generateTileGraph [**Deprecated**]~~
+
+<Badge text="Deprecated" type="warning" />
+
+Rsdoctor 默认支持生成 Tree Map 图，所以不需要配置此选项。
+
+## parseBundle
+
+- **类型：** `boolean`
+- **默认值：** `true`
+
+在部分大型仓库中，反解 Bundle 解析执行耗时过大，这是因为 Parse Bundle 的分析利用了 AST 解析与处理。当产物文件过多时，耗时也会增加。如果不需要此功能，可以通过 `supports.parseBundle` 配置进行选择性关闭。示例如下：
+
+```ts
+chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
+  {
+    supports: {
+      parseBundle: false,
+    },
+  },
+]);
+```
+
+关闭 Parse Bundle 能力只会影响是否能查看到 Bundle 中 Module 的最终打包大小（Bundled Size）及最终打包代码（Bundled Code）:
+
+<div style={{ display: 'flex' }}>
+  <img
+    src="https://assets.rspack.rs/others/assets/rsdoctor/bundled-size.jpeg"
+    height="300px"
+    width="300px"
+    style={{ margin: 'auto' }}
+  />
+
+  <img
+    src="https://assets.rspack.rs/others/assets/rsdoctor/bundled-code.png"
+    height="300px"
+    width="400px"
+    style={{ margin: 'auto' }}
+  />
+</div>

package/docs/zh/config/options/term.mdx

@@ -8,3 +8,36 @@
 
 - 其**文件名为 `manifest.json`**
 - 该文件的输出**路径为 `项目产物目录/.rsdoctor/manifest.json`**
+
+### 产物中的名词释义
+
+### assets（资源|产物文件）
+
+**定义：**  
+指的是项目中所有静态文件，例如图片、字体、CSS、JS、SVG 等。它们是构建后被输出到目标目录的文件，最终会被浏览器加载和使用。
+
+**举例：**
+
+- `logo.png`、`main.css`、`app.js` 都属于资源。
+
+### chunk
+
+**定义：**  
+Rspack 会把多个模块（JS、CSS 等）打包成一个或多个文件，这些文件就是 bundle。一个 chunk 可能包含多个 Assets，例如：name 为 index 的 chunk 可能包含 index.js 和 index.css 两个产物。
+
+### module（模块）
+
+**定义：**  
+在 Rspack 中，任何文件都可以被视为模块。最常见的是 JS 模块（通过 `import` 或 `require`），但也可以是 CSS、图片等。模块是构建中的最小单元，Rspack 通过依赖图将它们组织起来。Assets 是由 Modules 集合组成的。
+
+**举例：**
+
+- 第三方文件或源码文件，例如 `index.js`、`button.js`、`style.css`，都是模块，这些文件不是产物文件，但是会参与到产物文件的打包过程中，并且可能会最终被打包到产物文件中。
+
+### 总结对比
+
+| 英文名 | 中文定义 | Rspack 中的作用                                |
+| ------ | -------- | ---------------------------------------------- |
+| assets | 资源     | 最终产物，静态文件                             |
+| chunk  |          | 输出的打包文件，一个 chunk 可能包含多个 assets |
+| module | 模块     | 构建的最小单元，源文件                         |

package/docs/zh/guide/more/faq.mdx

@@ -94,19 +94,19 @@ export default {
 - rspeedy 项目中，在 `rspeedy.config.ts` 中配置：
 
 ```js rspeedy.config.ts
-  export default {
-    tools: {
-      rspack(config, { env }) {
-        if (process.env.RSDOCTOR === 'true') {
-            config.optimization = {
-              ...config.optimization,
-              concatenateModules: false,
-            },
-            return config
-          }
-      },
+export default {
+  tools: {
+    rspack(config, { env }) {
+      if (process.env.RSDOCTOR === 'true') {
+        config.optimization = {
+          ...config.optimization,
+          concatenateModules: false,
+        };
+        return config;
+      }
     },
-  };
+  },
+};
 ```
 
 ## CssExtractRspackPlugin 的 loader 耗时过长问题

package/docs/zh/guide/rules/rule-custom.mdx

@@ -73,7 +73,7 @@ export default {
 
 import { PackageManagerTabs } from '@theme';
 
-import { Tab, Tabs } from 'rspress/theme';
+import { Tab, Tabs } from '@rspress/core/theme';
 
 <PackageManagerTabs command="add @rsdoctor/core -D" />
 
@@ -200,19 +200,15 @@ const CheckRule = defineRule<typeof ruleTitle, config>(() => ({
   [LinkRule Type](#linkrulestoredata)
 
 - 组件输入
-
   - type
-
     - 使用组件类型。
     - value： 'link'。
 
   - title
-
     - 规则标题。
     - type： string。
 
   - description
-
     - 规则描述。数据来源为 report 中的 message 或 detail.description:
       ```js
       report({
@@ -226,7 +222,6 @@ const CheckRule = defineRule<typeof ruleTitle, config>(() => ({
     - type： string。
 
   - level
-
     - 规则级别。
     - type：warn | error。
 
@@ -267,19 +262,15 @@ report({
   [CodeViewRule Type](#codeviewrule)
 
 - 组件输入
-
   - type
-
     - 使用组件类型。
     - value： 'code-view'。
 
   - title
-
     - 规则标题。
     - type： string。
 
   - description
-
     - 规则描述。数据来源为 report 中的 message 或 detail.description:
       ```js
       report({
@@ -293,7 +284,6 @@ report({
     - type： string。
 
   - level
-
     - 规则级别。
     - type：warn | error。
 

package/docs/zh/guide/start/cli.mdx

@@ -17,7 +17,7 @@
 
 import { PackageManagerTabs } from '@theme';
 
-import { Tab, Tabs } from 'rspress/theme';
+import { Tab, Tabs } from '@rspress/core/theme';
 
 <PackageManagerTabs command="add @rsdoctor/cli -D" />
 
@@ -76,18 +76,18 @@ rsdoctor bundle-diff --baseline="baseline/.rsdoctor/manifest.json" --current="cu
 
 <Tabs>
 
-<Tab label="cjs">
+<Tab label="esm">
 
 ```js
-const { execute } = require('@rsdoctor/cli');
+import { execute } from '@rsdoctor/cli';
 ```
 
 </Tab>
 
-<Tab label="esm">
+<Tab label="cjs">
 
 ```js
-import { execute } from '@rsdoctor/cli';
+const { execute } = require('@rsdoctor/cli');
 ```
 
 </Tab>

package/docs/zh/guide/start/intro.mdx

@@ -4,7 +4,7 @@ Rsdoctor 是一款为 [Rspack](https://rspack.rs/) 生态量身打造的构建
 
 Rsdoctor 致力于成为一站式、智能化的构建分析工具，通过可视化与智能分析，使整个构建流程变得透明、可预测和可优化，从而帮助开发团队精准定位瓶颈、优化性能并提升工程质量。
 
-Rsdoctor 支持所有基于 Rspack 或 webpack 的工具和框架，例如：[Docusaurus](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-rsdoctor)、[Rspeedy (Lynx)](https://lynxjs.org/rspeedy/)、[Storybook](https://github.com/rspack-contrib/storybook-rsbuild)、[Next.js](https://nextjs.org/)、[Nuxt](https://nuxt.com/)、[Re.Pack](https://re-pack.dev/)、[Modern.js](https://modernjs.dev/)、[Rsbuild](https://rsbuild.rs/)、[Rspress](https://rspress.rs/) 和 [Rslib](https://lib.rsbuild.rs/) 等。
+Rsdoctor 支持所有基于 Rspack 或 webpack 的工具和框架，例如：[Docusaurus](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-rsdoctor)、[Rspeedy (Lynx)](https://lynxjs.org/rspeedy/)、[Storybook](https://github.com/rspack-contrib/storybook-rsbuild)、[Next.js](https://nextjs.org/)、[Nuxt](https://nuxt.com/)、[Re.Pack](https://re-pack.dev/)、[Modern.js](https://modernjs.dev/)、[Rsbuild](https://rsbuild.rs/)、[Rspress](https://rspress.rs/) 和 [Rslib](https://rslib.rs/) 等。
 
 <video
   src="https://assets.rspack.rs/others/assets/rsdoctor/rsdoctor-1.0-ui.mp4"

package/docs/zh/guide/start/quick-start-shared.mdx

@@ -84,7 +84,7 @@ export default {
 
 在 `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)） 插件。
 
-import { Tab, Tabs } from 'rspress/theme';
+import { Tab, Tabs } from '@rspress/core/theme';
 
 <Tabs>
 <Tab label="Rspack">

package/docs/zh/guide/usage/module-analysis.mdx

@@ -48,9 +48,8 @@
 - `Usage` 标签会展示各种模块标签的作用。
 
 - `Concatenated`标签:
-
   - `Concatenated` 标签标识该模块是被串联的子模块，`hover` 上去就可以看到被聚合到了哪个主模块中。这种聚合模块无法继续拆解打包后的代码，因此无法得知具体的 `Bundled Size`，只能得知整个串联模块的大小。
-  - 名词解释：串联模块是将多个模块在打包时提升或串联到一个闭包中。 `Concatenated Module` 的解释可以查看[名词解释](guide/usage/bundle-size#%E5%90%8D%E8%AF%8D%E8%A7%A3%E9%87%8A)。
+  - 名词解释：串联模块是将多个模块在打包时提升或串联到一个闭包中。 `Concatenated Module` 的解释可以查看[名词解释](/guide/usage/bundle-size#%E5%90%8D%E8%AF%8D%E8%A7%A3%E9%87%8A)。
 
 - `!` 标签，`hover` 上去可以展示模块详细路径.
 

package/docs/zh/shared/mode-intro.md

@@ -3,3 +3,4 @@
 - **brief 模式：** 在构建产物目录的 `.rsdoctor` 文件夹中生成一个 HTML 报告文件，所有构建分析数据会整合注入到这个 HTML 文件中，可以通过浏览器打开该 HTML 文件查看报告。brief 模式还有更多配置项，详细信息请参阅：[brief](/config/options/options#brief).
 
 - **lite 模式：** 基于普通模式，不展示源码和产物代码，仅显示打包后的代码信息。
+  - lite 模式即将在 V2 废弃，参考 [lite 模式废弃说明](/config/options/options-v2#lite)。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdoctor/docs",
-  "version": "1.2.3",
+  "version": "1.2.4-beta.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -18,29 +18,32 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@rspress/plugin-algolia": "2.0.0-beta.20",
-    "@rspress/plugin-llms": "2.0.0-beta.20",
-    "@rspress/plugin-rss": "2.0.0-beta.6",
+    "@rspress/plugin-algolia": "2.0.0-beta.29",
+    "@rspress/plugin-llms": "2.0.0-beta.29",
+    "@rspress/plugin-rss": "2.0.0-beta.29",
     "@types/node": "^22.8.1",
-    "@types/react": "^18.3.23",
+    "@types/react": "^18.3.24",
     "@types/react-dom": "^18.3.7",
+    "cross-env": "^7.0.3",
     "react": "18.3.1",
     "react-dom": "18.3.1",
-    "rsbuild-plugin-google-analytics": "^1.0.3",
-    "rsbuild-plugin-open-graph": "^1.0.2",
-    "rspress-plugin-font-open-sans": "^1.0.0",
+    "rsbuild-plugin-google-analytics": "^1.0.4",
+    "rsbuild-plugin-open-graph": "^1.1.0",
+    "rspress-plugin-font-open-sans": "^1.0.3",
     "rspress-plugin-sitemap": "^1.1.4",
-    "typescript": "^5.2.2",
-    "@rsdoctor/types": "1.2.3"
+    "typescript": "^5.9.2",
+    "@rsbuild/plugin-sass": "^1.4.0",
+    "@rsdoctor/types": "1.2.4-beta.1"
   },
   "dependencies": {
-    "@rstack-dev/doc-ui": "1.10.8",
+    "@rstack-dev/doc-ui": "1.11.0",
+    "clsx": "^2.1.1",
     "react-markdown": "^9.1.0",
-    "rspress": "2.0.0-beta.6"
+    "@rspress/core": "2.0.0-beta.29"
   },
   "scripts": {
-    "dev": "rspress dev",
-    "build": "rspress build",
+    "dev": "cross-env RSPRESS_PERSIST_CACHE=false rspress dev",
+    "build": "cross-env RSPRESS_PERSIST_CACHE=false rspress build && sh build.sh",
     "preview": "rspress preview"
   }
 }