> For AI agents: the complete documentation index is available at https://rspack.rs/zh/llms.txt, the full documentation bundle is available at https://rspack.rs/zh/llms-full.txt.

# 使用 Rsdoctor

[Rsdoctor](https://rsdoctor.rs/zh/) 是为 Rspack 生态打造的构建分析工具，通过可视化呈现构建过程与产物，帮助开发者排查构建问题、定位性能瓶颈；同时为 Agent 提供构建数据，支持对 JavaScript 程序的自动诊断与优化。

## 环境要求

Rsdoctor 2.0 要求 Node.js `^20.19.0 || >=22.12.0` 和 Rspack 2.0 及以上版本。使用 Rspack 1.x 或 webpack 的项目应继续使用 Rsdoctor 1.x。

## 如何使用

1. 安装 `@rsdoctor/core`：


```sh [npm]
npm add @rsdoctor/core@latest -D
```

```sh [yarn]
yarn add @rsdoctor/core@latest -D
```

```sh [pnpm]
pnpm add @rsdoctor/core@latest -D
```

```sh [bun]
bun add @rsdoctor/core@latest -D
```

```sh [deno]
deno add npm:@rsdoctor/core@latest -D
```

从 Rsdoctor 1.x 升级时，请参考 [Rsdoctor 2.0 迁移指南](https://rsdoctor.rs/zh/guide/migration/migration-v2)。

2. 在 Rspack 的 [plugins](https://rspack.rs/zh/config/plugins.md) 选项中注册 `RsdoctorRspackPlugin`。Rsdoctor 2.0 的包仅支持 ESM，因此请使用 ESM 配置文件和导入语法：

```js title="rspack.config.mjs"
import { RsdoctorRspackPlugin } from '@rsdoctor/core';

export default {
  plugins: [
    // 仅在 RSDOCTOR 为 true 时注册插件，因为插件会增加构建耗时
    process.env.RSDOCTOR &&
      new RsdoctorRspackPlugin({
        // 插件选项
      }),
  ],
};
```

3. 运行 Rspack 时设置 `RSDOCTOR=true`：

```bash
RSDOCTOR=true rspack serve
RSDOCTOR=true rspack build
```

在 Windows 上，使用 [cross-env](https://npmjs.com/package/cross-env) 设置环境变量：

```bash
cross-env RSDOCTOR=true rspack serve
cross-env RSDOCTOR=true rspack build
```

构建完成后，Rsdoctor 会打开分析页面。更多用法请参考 [Rsdoctor 2.0 快速开始](https://rsdoctor.rs/zh/guide/start/quick-start)。