@rsdoctor/docs 1.2.3 → 1.2.4-beta.1

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

@@ -0,0 +1,70 @@
+# features
+
+- **类型：** [RsdoctorWebpackPluginFeatures](#rsdoctorwebpackpluginfeatures) | [Array\<keyof RsdoctorWebpackPluginFeatures\>](#rsdoctorwebpackpluginfeatures) | [RsdoctorRspackPluginFeatures](#rsdoctorrspackpluginfeatures) | [Array\<keyof RsdoctorRspackPluginFeatures\>](#rsdoctorrspackpluginfeatures)
+- **可选：** `true`
+- **默认值：** `["loader", "plugins", "bundle"]`
+
+## 配置项说明
+
+features 属性是用于分析功能开关的，具体的功能项如下：
+
+- **loader**：Loaders 耗时及代码编译变化分析，默认开启。
+- **plugins**：Plugins 调用以及耗时分析，默认开启。
+- **bundle**：构建产物分析，默认开启。
+- **resolver**：resolver 分析，默认关闭。
+- **lite**: **(lite 模式即将在 V2 废弃，参考[lite 模式废弃说明](/config/options/options-v2#lite))** lite 模式。lite 模式和普通模式的区别就是不再展示源码信息，只展示打包后的代码信息，这样分析页面上的代码也将是打包后的。默认普通模式。
+
+所以，**默认配置是开启了 Bundle 分析能力、 Loader 和 Plugin 构建时分析**。没有开启 Resolver 分析能力， Rspack 暂不支持 Resolver 分析能力。
+
+### 类型
+
+- 如果你将 `features` 设置为**数组**类型，该插件**只会开启**你在 `features` 数组中定义的功能。
+- 如果你将 `features` 设置为**简单对象**类型，该插件**只会关闭**你在 `features` 对象中值为 `false` 的功能。
+
+### 示例
+
+```js
+new RsdoctorRspackPlugin({
+  // 只开启 bundle、loader、plugins 的特性分析，数组形式会覆盖默认配置。
+  features: ['bundle', 'loader', 'plugins'],
+});
+```
+
+```js
+new RsdoctorRspackPlugin({
+  features: {
+    // 关闭 bundle 分析，其他特性分析保持默认
+    bundle: false,
+  },
+});
+```
+
+### 注意事项
+
+:::tip
+
+**如果出现了 out of memory 的报错，可以尝试：**
+
+1. 打开 **lite** 模式。
+2. 增大 node 内存上限，例如：NODE_OPTIONS=--max-old-space-size=8096。
+
+- 原因：因为构建过程中，缓存了源码信息，超过了内存，所以开启 `lite` 模式可以缓解。
+- 区别：`lite` 模式和普通模式的区别就是不再缓存源码信息，只缓存打包后的代码信息，这样分析页面上的代码也将是打包后的。
+
+:::
+
+## RsdoctorWebpackPluginFeatures
+
+`features` 类型如下：
+
+import Features from '@zh/shared/features.md';
+
+<Features />
+
+## RsdoctorRspackPluginFeatures
+
+`features` 类型如下：
+
+import FeaturesRspack from '@zh/shared/features-rspack.md';
+
+<FeaturesRspack />

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

@@ -0,0 +1,20 @@
+import { Badge } from '@theme';
+
+# mode
+
+:::warning
+
+- V2 中即将废弃，请使用 [output.mode](/config/options/output#mode) 代替。参考 [mode 配置迁移](/config/options/options-v2#mode)。
+
+:::
+
+- **类型：** `"normal" | "brief" | "lite"`
+  - lite 模式即将在 V2 废弃，参考[lite 模式废弃说明](/config/options/options-v2#lite)
+- **可选：** `true`
+- **默认值：** `normal`
+
+选择使用的 Rsdoctor 构建报告模式，有以下几种：
+
+import ModeIntro from '@zh/shared/mode-intro.md';
+
+<ModeIntro />

package/docs/zh/config/options/options-v2.mdx

@@ -0,0 +1,40 @@
+# 配置迁移说明
+
+**Rsdoctor 在 1.2.4 版本中引入了新的配置项，新的配置项更易于配置，更好扩展，与以后发布的 v2.0 版本兼容**。
+
+1.2.3 及之前版本的配置项仍会保留，**但在 Rsdoctor v2 时会完全废弃掉**，推荐迁移到 `1.2.4` 的新版配置。
+
+| 原配置                              | 新配置                                                                                                           |
+| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| mode                                | 改为配置 `output.mode`。                                                                                         |
+| brief                               | 改为配置 `mode: 'brief'`，同时，配置 `output.options` 的 `type` 为 `html`。                                      |
+| output.compressData                 | 改为配置 `mode: 'brief'`，同时，配置 `output.options.type` 为 `json`。                                           |
+| `mode: 'lite'` 或 `feature: 'lite'` | 改为配置 `mode: 'normal'`，同时，配置 `output.options.reportCodeType` 为 `noCode` 或 `noAssetsAndModuleSource`。 |
+| 无                                  | 新增 `output.options.jsonOptions.section` 配置                                                                   |
+
+## 配置改动详情
+
+### mode
+
+原有配置中的 `mode` 迁移为嵌套的 `output.mode`，便于与其他输出相关的配置整合。
+
+### brief
+
+目前的 brief 简报模式输出一个 html 文件为报告页，新增的 brief 模式还是支持 JSON 格式，同时也为了相同配置统一管理，所以 brief 配置前移到了 output.options 中。
+原有的 `brief` 配置改为配置 `output.mode: 'brief'`，同时配置 `output.options` 的 `type` 为 `html`。
+
+### output.compressData
+
+原有的 `output.compressData` 配置改为配置 `mode: 'brief'`，同时配置 `output.options.type` 为 `json`。
+
+### lite
+
+lite 模式的内部逻辑等同于 `output.options.reportCodeType` 为 `noCode` 或 `noAssetsAndModuleSource`，主要是为了解决大项目在打开报告时过慢或者构建时 OOM 的问题。
+
+考虑到用户并不能清楚分辨 lite 模式的实际含义，mode 太多也不利于管理和配置，同时，`output.options.reportCodeType` 配置更加清晰，所以未来 V2 版本中会废弃掉 `mode: 'lite'`。
+
+原有的 `mode: 'lite'` 和 `feature: 'lite'` 配置改为配置 `mode: 'normal'`，同时配置 `output.options.reportCodeType` 为 `noCode` 或 `noAssetsAndModuleSource`。
+
+### 新增 output.options.jsonOptions.section
+
+支持新增的 `output.options.jsonOptions.section` 配置，用于更细粒度的 JSON 输出选项定制。具体 sections 配置项参考[output.options.jsonOptions.section](/config/options/output#jsonoptionssection)。

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

@@ -1,17 +1,17 @@
-import { Badge } from '@theme';
+import { Badge, Tab, Tabs } from '@theme';
 
-# Options 配置
+# 总览
 
 ## RsdoctorRspackPlugin 插件
 
-**RsdoctorRspackPlugin** 类由 `@rsdoctor/rspack-plugin` 导出，配置项是 [RsdoctorRspackPluginOptions](#options-1)。
+**RsdoctorRspackPlugin** 类由 `@rsdoctor/rspack-plugin` 导出，配置项是 [RsdoctorRspackPluginOptions](#rsdoctorrspackpluginoptions)。
 
 <Tabs>
 
-<Tab label="cjs">
+<Tab label="esm">
 
-```js
-const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');
+```ts
+import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';
 
 new RsdoctorRspackPlugin({
   /** RsdoctorRspackPluginOptions */
@@ -20,10 +20,10 @@ new RsdoctorRspackPlugin({
 
 </Tab>
 
-<Tab label="esm">
+<Tab label="cjs">
 
-```ts
-import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';
+```js
+const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');
 
 new RsdoctorRspackPlugin({
   /** RsdoctorRspackPluginOptions */
@@ -36,16 +36,14 @@ new RsdoctorRspackPlugin({
 
 ## RsdoctorWebpackPlugin 插件
 
-**RsdoctorWebpackPlugin** 类由 `@rsdoctor/webpack-plugin` 导出，配置项是 [RsdoctorWebpackPluginOptions](#options-1)。
-
-import { Tab, Tabs } from '@theme';
+**RsdoctorWebpackPlugin** 类由 `@rsdoctor/webpack-plugin` 导出，配置项是 [RsdoctorWebpackPluginOptions](#rsdoctorwebpackpluginoptions)。
 
 <Tabs>
 
-<Tab label="cjs">
+<Tab label="esm">
 
-```js
-const { RsdoctorWebpackPlugin } = require('@rsdoctor/webpack-plugin');
+```ts
+import { RsdoctorWebpackPlugin } from '@rsdoctor/webpack-plugin';
 
 new RsdoctorWebpackPlugin({
   /** RsdoctorWebpackPluginOptions */
@@ -54,10 +52,10 @@ new RsdoctorWebpackPlugin({
 
 </Tab>
 
-<Tab label="esm">
+<Tab label="cjs">
 
-```ts
-import { RsdoctorWebpackPlugin } from '@rsdoctor/webpack-plugin';
+```js
+const { RsdoctorWebpackPlugin } = require('@rsdoctor/webpack-plugin');
 
 new RsdoctorWebpackPlugin({
   /** RsdoctorWebpackPluginOptions */
@@ -68,269 +66,67 @@ new RsdoctorWebpackPlugin({
 
 </Tabs>
 
-## Options
+## 配置项
 
 **类型：** `Object`
 
-这个 `Options` 是 [RsdoctorWebpackPlugin](#rsdoctorwebpackplugin-%E6%8F%92%E4%BB%B6) 和 [RsdoctorRspackPlugin](#rsdoctorrspackplugin-%E6%8F%92%E4%BB%B6) 的配置项。它包含以下属性值：
-
-- [brief](#brief)
-- [disableClientServer](#disableclientserver)
-- [experiments](#experiments)
-- [features](#features)
-- [mode](#mode)
-- [output](#output)
-- [port](#port)
-- [supports](#supports)
-
-### brief
-
-<Badge text="Version: 0.4.0" type="warning" />
+这个 `Options` 是 [RsdoctorRspackPlugin](#rsdoctorrspackplugin-%E6%8F%92%E4%BB%B6) 和 [RsdoctorWebpackPlugin](#rsdoctorwebpackplugin-%E6%8F%92%E4%BB%B6) 的配置项。它包含以下属性值：
 
-- **类型：** [BriefType](#brieftype)
-- **可选：** `true`
-- **默认值：** `undefined`
+- [disableClientServer](./disableClientServer.mdx) - **客户端服务控制**：是否在分析完成后不自动打开 Rsdoctor 报告服务。
+- [experiments](./experiments.mdx) - **实验性功能配置**：启用 Rspack 插件的实验性功能，如原生插件性能优化。
+- [features](./features.mdx) - **特性开关配置**：控制 Rsdoctor 的各项分析功能，如 loader 分析、bundle 分析、规则检查等
+- [output](./output.mdx) - **输出相关配置**：控制报告的输出格式、目录等选项，包括 mode、options、reportCodeType 等
+- [port](./port.mdx) - **服务端口配置**：设置 Rsdoctor 开发服务器的端口号，用于本地开发时的报告预览
+- [supports](./supports.mdx) - **特性支持配置**：启用特定构建工具的兼容性支持，如 BannerPlugin 等
+- [brief](./brief.mdx) - **Brief 模式的配置**：控制简要模式报告的生成，包括 HTML 文件名和是否生成 JSON 数据文件
+- [mode](./mode.mdx) - **构建报告数据输出模式**：选择报告的输出模式，支持 normal（普通模式）和 brief（简要模式）
 
-Brief 模式更多配置，如下：
-
-- **reportHtmlName:** 配置 Brief 的 HTML 报告的名称，默认 `report-rsdoctor.html`。
-- **writeDataJson:** 默认 Brief 模式下将分析数据注入到 HTML 文件中，所以不会再产生构建分析数据。如果想要而外本地生成数据则需要配置 `writeDataJson: true`。
-
-#### briefType
+### RsdoctorRspackPluginOptions
 
 ```ts
-interface BriefConfig {
-  reportHtmlName?: string | undefined;
-  writeDataJson: boolean;
-}
-```
-
-### disableClientServer
-
-- **类型：** `boolean`
-- **可选：** `true`
-- **默认值：** `false`
-
-:::tip
-建议在 CI 环境下将 disableClientServer 设置为 true，否则启动的服务会卡住 pipeline 流程.
-:::
-
-是否需要自动打开 Rsdoctor 报告页面。如果你不需要在浏览器内查看本次 Rsdoctor 提供的分析报告，则可以开启这个配置项。
-
-### experiments
-
-<Badge text="Version: 1.0.0" type="warning" />
-
-#### enableNativePlugin
-
-- **类型：** `boolean`
-- **可选：** `true`
-- **默认值：** `false`
-
-##### Description
-
-通过在 Rspack 中集成 Rsdoctor 的原生插件，我们将 Rsdoctor 中耗时较大的数据处理逻辑前置到 Rspack 的构建阶段。这一特性显著提升了 Rspack 中 Rsdoctor 的构建分析效率，减少了整体分析时间。
-
-- enableNativePlugin：是否开启 Rspack 原生插件，开启后可大幅降低 Rsdoctor 自身的分析耗时。
-
-- **示例：**
-
-```js
-new RsdoctorRspackPlugin({
-  experiments: { enableNativePlugin: true }
-}),
-```
-
-### features
-
-- **类型：** [RsdoctorWebpackPluginFeatures](#rsdoctorwebpackpluginfeatures) | [Array\<keyof RsdoctorWebpackPluginFeatures\>](#rsdoctorwebpackpluginfeatures) | [RsdoctorRspackPluginFeatures](#rsdoctorrspackpluginfeatures) | [Array\<keyof RsdoctorRspackPluginFeatures\>](#rsdoctorrspackpluginfeatures)
-- **可选：** `true`
-- **默认值：** `['loader', 'plugins', 'bundle']`
-
-#### features values
-
-features 属性是用于分析功能开关的，具体的功能项如下：
-
-- **loader**：Loaders 耗时及代码编译变化分析，默认开启。
-- **plugins**：Plugins 调用以及耗时分析，默认开启。
-- **bundle**：构建产物分析，默认开启。
-- **resolver**：resolver 分析，默认关闭。
-- **lite**: **(废弃，使用 [mode.lite](#mode))** lite 模式。lite 模式和普通模式的区别就是不再展示源码信息，只展示打包后的代码信息，这样分析页面上的代码也将是打包后的。默认普通模式。
-
-所以，**默认配置是开启了 Bundle 分析能力、 Loader 和 Plugin 构建时分析**。没有开启 Resolver 分析能力， Rspack 暂不支持 Resolver 分析能力。
-
-:::tip
-**如果出现了 out of memory 的报错，可以尝试：**
+interface RsdoctorWebpackPluginOptions<
+  Rules extends LinterType.ExtendRuleData[],
+> {
+  linter?: LinterType.Options<Rules, InternalRules>;
 
-1. 打开 **lite** 模式。
-2. 增大 node 内存上限，例如：NODE_OPTIONS=--max-old-space-size=8096。
+  /** Rsdoctor 功能开关 */
+  features?:
+    | Plugin.RsdoctorWebpackPluginFeatures
+    | Array<keyof Plugin.RsdoctorWebpackPluginFeatures>;
 
-- 原因：因为构建过程中，缓存了源码信息，超过了内存，所以开启 `lite` 模式可以缓解。
-- 区别：`lite` 模式和普通模式的区别就是不再缓存源码信息，只缓存打包后的代码信息，这样分析页面上的代码也将是打包后的。
+  /**
+   * @deprecated 使用 `output.mode` 代替，如果使用 `lite` 模式，请使用 `output.reportCodeType: 'noCode' or 'noAssetsAndModuleSource'` 代替
+   * Rsdoctor 模式选项：
+   * - normal: 普通模式
+   * - brief: 简要模式，仅显示持续时间分析和构建产物分析结果，不显示任何代码部分
+   */
+  mode?: 'brief' | 'normal' | 'lite';
 
-:::
+  disableClientServer?: boolean;
 
-#### features types
+  supports?: ISupport;
 
-- 如果你将 `features` 设置为**数组**类型，该插件**只会开启**你在 `features` 数组中定义的功能。
-- 如果你将 `features` 设置为**简单对象**类型，该插件**只会关闭**你在 `features` 对象中值为 `false` 的功能。
+  port?: number;
 
-#### RsdoctorWebpackPluginFeatures
+  /**
+   * @deprecated 使用 `output.options.htmlOptions` 代替
+   */
+  brief?: Config.BriefConfig;
 
-`features` 类型如下：
+  output?: Config.IOutput<'brief' | 'normal'>;
 
-import Features from '@zh/shared/features.md';
-
-<Features />
-
-#### RsdoctorRspackPluginFeatures
-
-`features` 类型如下：
-
-import FeaturesRspack from '@zh/shared/features-rspack.md';
-
-<FeaturesRspack />
-
-### mode
-
-<Badge text="Version: 0.4.0" type="warning" />
-
-- **类型：** `normal | brief | lite`
-- **可选：** `true`
-- **默认值：** `normal`
-
-选择使用的 Rsdoctor 构建报告模式，有以下几种：
-
-import ModeIntro from '@zh/shared/mode-intro.md';
-
-<ModeIntro />
-
-### output
-
-<Badge text="Version: 1.0.0" type="warning" />
-
-#### compressData
-
-- **类型：** `boolean`
-- **可选：** `true`
-- **默认值：** `true`
-
-compressData 用于配置是否将 [outputDir]/.rsdoctor 下的分析数据进行压缩处理。
-
-#### reportCodeType
-
-- **类型：** `{ noModuleSource?: boolean; noAssetsAndModuleSource?: boolean }`
-- **可选：** `true`
-- **默认值：** `undefined`
-- **描述：**
-
-  - 选择输出的分析数据：
-    - 默认是所有完整数据；
-    - noModuleSource: true 是输出除了 module 代码之外的数据，Module 代码即 Bundle 内一个一个文件的打包模块代码。
-    - noAssetsAndModuleSource: true 是输出除了 module 代码和 Assets 产物代码之外的数据。
-
-- **示例：**
-
-```js
-new RsdoctorRspackPlugin({
-  reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
-}),
-```
-
-#### reportDir
-
-- **类型：** `string`
-- **可选：** `true`
-- **默认值：** `undefined`
-
-Rsdoctor 报告输出目录，默认是构建产物输出目录。
-
-### port
-
-- **类型：** `number`
-- **可选：** `true`
-- **默认值：** `random(3000, 8999)`
-
-配置 Rsdoctor 服务的端口。
-
-### ~~reportCodeType [**Deprecated**]~~
-
-<Badge text="Deprecated" type="warning" />
-
-请看 [output.reportCodeType](#reportcodetype)
-
-### ~~reportDir [**Deprecated**]~~
-
-<Badge text="Deprecated" type="warning" />
-
-请看 [output.reportDir](#reportdir)
-
-### supports
-
-- **类型：** [Supports Types](#supports-types)
-- **可选：** `true`
-- **默认值：** `undefined`
-
-该选项是配置 Rsdoctor 是否开启某些细节特性分析能力支持的，例如：是否开启对 BannerPlugin 的兼容能力。
-
-#### supportsTypes
+  experiments?: RsdoctorRspackPluginExperiments;
+}
 
-```ts
-type ISupport = {
-  banner?: boolean;
-  parseBundle?: boolean;
-  generateTileGraph?: boolean;
-};
+interface RsdoctorRspackPluginExperiments {
+  /**
+   * 是否启用原生插件以提高性能
+   * @default false
+   */
+  enableNativePlugin?: 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,
-    },
-  },
-]);
-```
+### RsdoctorWebpackPluginOptions
 
-关闭 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>
+RsdoctorWebpackPlugin 同 `Omit<RsdoctorRspackPluginOptions, 'experiments'>` 类型。

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

@@ -0,0 +1,162 @@
+import { Badge } from '@theme';
+
+# output
+
+## mode
+
+<Badge text="V1.2.4 新增" type="tip" />
+
+- **类型：** `"normal" | "brief"`
+
+Rsdoctor 报告模式，默认是 `normal`。
+
+- **normal:** 在构建产物目录中生成一个 `.rsdoctor` 文件夹，其中包含各种数据文件，并在报告页面中展示代码。输出目录可以通过 [reportDir](#reportdir) 进行配置。
+- **brief:** 在构建产物目录的 `.rsdoctor` 文件夹中生成一个 HTML 报告文件，所有构建分析数据会整合注入到这个 HTML 文件中，可以通过浏览器打开该 HTML 文件查看报告。brief 模式还有更多配置项，详细信息请参阅：[brief](#brief)。
+
+:::tip
+mode 是没有 lite 配置项的，lite 模式即将废弃，参考 [lite 模式废弃说明](./options-v2.mdx#lite-模式废弃说明)。
+:::
+
+## options
+
+<Badge text="V1.2.4 新增" type="tip" />
+
+- **类型：** `BriefModeOptions | NormalModeOptions`
+- **可选：** `true`
+- **默认值：** `undefined`
+- **描述：**
+  根据不同的 `mode` 配置，`options` 支持不同的配置项：
+
+### mode: 'brief'
+
+Brief 模式用于生成轻量级的分析报告，支持 HTML 和 JSON 两种输出格式。
+
+- **`type`**：输出类型，支持 `'html'` 和 `'json'` 数组，可同时选择多种格式
+- **`htmlOptions`**：HTML 输出相关配置
+  - **`reportHtmlName`**：HTML 报告文件名，默认为 `report-rsdoctor.html`
+- **`jsonOptions`**：JSON 输出相关配置
+  - **`sections`**：JSON 输出包含的模块配置
+    - **`moduleGraph`**：是否包含模块图数据，默认为 `true`
+    - **`chunkGraph`**：是否包含 Chunk 图数据，默认为 `true`
+    - **`rules`**：是否包含规则数据，默认为 `true`
+
+**配置示例：**
+
+```js
+new RsdoctorRspackPlugin({
+  output: {
+    mode: 'brief',
+    options: {
+      // 同时输出 HTML 和 JSON 格式
+      type: ['html', 'json'],
+      htmlOptions: {
+        reportHtmlName: 'my-report.html',
+      },
+    },
+  },
+});
+```
+
+**注意事项：**
+
+- Brief 模式下，**`reportCodeType`** 配置项无效，因为只支持 **`'noCode'`**。
+- Brief 模式下，**type 为 'html' 时**，分析数据会直接注入到 HTML 文件中，便于单文件分享。
+- Brief 模式下，**type 为 'json' 时**，会生成结构化的数据文件，便于程序化处理。
+
+### mode: 'normal'
+
+Normal 模式下的 `options` 为空对象，无额外配置项。
+
+### 类型定义
+
+#### BriefModeOptions
+
+```ts
+interface BriefModeOptions {
+  /** 输出类型，支持 HTML 和 JSON */
+  type?: Array<'html' | 'json'>;
+  /** HTML 输出相关配置 */
+  htmlOptions?: BriefConfig;
+  /** JSON 输出相关配置 */
+  jsonOptions?: JsonOptions;
+}
+
+interface BriefConfig {
+  /** HTML 报告文件名，默认为 report-rsdoctor.html */
+  reportHtmlName?: string;
+  /** 是否额外生成 JSON 数据文件，默认为 false */
+  writeDataJson: boolean;
+}
+
+interface JsonOptions {
+  /** JSON 输出包含的模块配置 */
+  sections?: JsonSectionOptions;
+}
+
+interface JsonSectionOptions {
+  /** 是否包含模块图数据，默认为 true */
+  moduleGraph?: boolean;
+  /** 是否包含 Chunk 图数据，默认为 true */
+  chunkGraph?: boolean;
+  /** 是否包含规则数据，默认为 true */
+  rules?: boolean;
+}
+```
+
+#### NormalModeOptions
+
+NormalModeOptions 目前类型为空 Object。
+
+## reportCodeType
+
+- **类型：** `"noModuleSource" | "noAssetsAndModuleSource" | "noCode" | { noModuleSource?: boolean; noAssetsAndModuleSource?: boolean; noCode?: boolean }`
+  - **V2 时，类型将只支持 String 类型。**
+- **可选：** `true`
+- **默认值：** `undefined`，undefined 时输出所有完整数据。
+- **描述：**
+  选择输出的分析数据范围：
+  - **默认**：输出所有完整数据
+  - **`noModuleSource`**：输出除模块（[Module](https://rspack.rs/config/module#module)）代码外的数据，模块（[Module](https://rspack.rs/config/module#module)）代码即产物（（[Module](https://rspack.rs/config/module#module)））内各个文件的打包模块代码
+  - **`noAssetsAndModuleSource`**：输出除模块（[Module](https://rspack.rs/config/module#module)）代码和 Assets 产物代码外的数据
+  - **`noCode`**：输出除代码外的数据，即不输出任何代码
+
+### 输出数据对比表
+
+| 配置项                      | 包含的数据                                                                               | 不包含数据                                                  | 适用场景                                                               | 文件大小 |
+| --------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------- | -------- |
+| **默认** (不配置)           | **完整构建信息：**<br/>• Modules 数据及其打包后代码<br/>• Assets 代码<br/>• 其他分析数据 | 无                                                          | • 开发调试<br/>• 完整分析                                              | 最大     |
+| **noModuleSource**          | • 构建信息<br/>• Modules 数据及其打包后代码<br/>• Assets 代码<br/>• 其他分析数据         | Modules 源代码                                              | • 不需要查看源代码<br/>• 发生内存泄漏问题                              | 中等     |
+| **noAssetsAndModuleSource** | • 构建信息<br/>• Modules 数据及其打包后代码<br/>• 其他分析数据                           | Module 源代码、Assets 代码                                  | • 大型项目<br/>• 不需要查看源代码和 Assets 代码<br/>• 发生内存泄漏问题 | 较小     |
+| **noCode**                  | • 构建信息<br/>• Modules 数据<br/>• 其他分析数据                                         | 所有代码（Module 源代码 + Module 打包后代码 + Assets 代码） | • 大型项目<br/>• CI/CD<br/>• 发生内存泄漏问题                          | 最小     |
+
+**数据输出从丰富到简的排序：** `默认` > `noModuleSource` > `noAssetsAndModuleSource` > `noCode`
+
+> Asset 和 Module 解释，见[术语](./term)
+
+- **示例：**
+
+```js
+new RsdoctorRspackPlugin({
+  reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
+}),
+```
+
+## reportDir
+
+- **类型：** `string`
+- **可选：** `true`
+- **默认值：** `undefined`
+
+Rsdoctor 报告输出目录，默认是构建产物输出目录。
+
+## compressData
+
+:::warning
+V2 中即将废弃，请使用 `output.mode: 'brief'` 和 `output.options.type: 'json'` 代替。参考 [compressData 配置迁移](/config/options/options-v2#compressdata)。
+:::
+
+- **类型：** `boolean`
+- **可选：** `true`
+- **默认值：** `true`
+
+compressData 用于配置是否将 `[outputDir]/.rsdoctor` 下的分析数据进行压缩处理。