#Use Rsdoctor

Rsdoctor is a build analysis tool for the Rspack ecosystem. It visualizes the build process and output to help developers investigate build issues and identify performance bottlenecks. It also provides build data to agents for automated diagnosis and optimization of JavaScript programs.

#Quick start

In an Rsbuild project, enable Rsdoctor as follows:

1. Install the Rsdoctor plugin:

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

To upgrade from Rsdoctor 1.x, see the Rsdoctor 2.0 migration guide.

2. Set the RSDOCTOR=true environment variable before running the CLI command:

{
  "scripts": {
    "dev:rsdoctor": "RSDOCTOR=true rsbuild",
    "build:rsdoctor": "RSDOCTOR=true rsbuild build"
  }
}

Because Windows does not support this syntax, you can use cross-env to set environment variables across different systems:

{
  "scripts": {
    "dev:rsdoctor": "cross-env RSDOCTOR=true rsbuild",
    "build:rsdoctor": "cross-env RSDOCTOR=true rsbuild build"
  },
  "devDependencies": {
    "cross-env": "^7.0.0"
  }
}

After running these scripts, Rsbuild automatically registers the Rsdoctor plugin and opens the build analysis page when the build finishes. See the Rsdoctor documentation for all features.

#Options

To configure the options exposed by the Rsdoctor plugin, manually register the plugin:

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

export default {
  tools: {
    rspack: {
      plugins: [
        process.env.RSDOCTOR === 'true' &&
          new RsdoctorRspackPlugin({
            // plugin options
          }),
      ],
    },
  },
};