#使用 Rsdoctor

Rsdoctor 是一款为 Rspack 生态量身打造的构建分析工具。

Rsdoctor 致力于成为一站式、智能化的构建分析工具，通过可视化与智能分析，使整个构建流程变得透明、可预测和可优化，从而帮助开发团队精准定位瓶颈、优化性能并提升工程质量。

当你需要调试构建产物或构建过程时，可以使用 Rsdoctor 排查问题。

#环境要求

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

#如何使用

1. 安装 @rsdoctor/core：

npm add @rsdoctor/core@latest -D

yarn add @rsdoctor/core@latest -D

pnpm add @rsdoctor/core@latest -D

bun add @rsdoctor/core@latest -D

deno add npm:@rsdoctor/core@latest -D

2. 在 Rspack 的 plugins 选项中注册 RsdoctorRspackPlugin。Rsdoctor 2.0 的包仅支持 ESM，因此请使用 ESM 配置文件和导入语法：

import { RsdoctorRspackPlugin } from '@rsdoctor/core';

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

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

RSDOCTOR=true rspack serve
RSDOCTOR=true rspack build

由于 Windows 不支持上述写法，你也可以使用 cross-env 设置环境变量，以兼容不同的操作系统：

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

构建完成后，Rsdoctor 会打开分析页面。更多用法请参考 Rsdoctor 2.0 快速开始。

#从 Rsdoctor 1.x 升级

将 @rsdoctor/rspack-plugin 替换为 @rsdoctor/core，并按上方示例修改导入。如果配置了 experiments.enableNativePlugin，请将其移除；Rsdoctor 2.0 默认启用 Rspack 原生插件。其他配置变更请参考 Rsdoctor 2.0 迁移指南。