Rsdoctor

https://rsdoctor.rs/
Admin
Rsdoctor is a one-stop build analyzer for Rspack and webpack that visualizes compilation behavior,...
Tokens:53,663
Snippets:825
Trust Score:6.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Analyze command usage example

Source: https://rsdoctor.rs/llms-full.txt

Example of using the analyze command with a local manifest.json file path.

```bash
rsdoctor analyze --profile "./dist/.rsdoctor/manifest.json"
```

--------------------------------

### Bundle diff command usage example

Source: https://rsdoctor.rs/llms-full.txt

Example of using the bundle-diff command with local paths for baseline and current manifest.json files.

```bash
rsdoctor bundle-diff --baseline="baseline/.rsdoctor/manifest.json" --current="current/.rsdoctor/manifest.json"
```

--------------------------------

### Install @rsdoctor/cli with bun

Source: https://rsdoctor.rs/llms-full.txt

Install the Rsdoctor CLI package as a development dependency using bun.

```sh
bun add @rsdoctor/cli -D
```

--------------------------------

### Trigger skill via natural language

Source: https://rsdoctor.rs/guide/start/ai

Example prompt for triggering the installed Rsdoctor skill.

```text
Use Rsdoctor to analyze this project and provide optimization suggestions
```

--------------------------------

### Install @rsdoctor/cli with deno

Source: https://rsdoctor.rs/llms-full.txt

Install the Rsdoctor CLI package as a development dependency using deno.

```sh
deno add npm:@rsdoctor/cli -D
```

--------------------------------

### Configure AGENTS.md

Source: https://rsdoctor.rs/guide/start/ai

Example content for an AGENTS.md file to provide project context to AI agents.

```markdown
# AGENTS.md

You are an expert in JavaScript, Rsdoctor, and build analysis.

## Tools

### Rsdoctor

- Run `RSDOCTOR=true npm run build` to build the app with Rsdoctor

## Docs

- Rsdoctor: https://rsdoctor.rs/llms.txt
```

--------------------------------

### Configuration Examples

Source: https://rsdoctor.rs/config/options/output

Provides JavaScript code examples for configuring Rsdoctor to generate HTML only, JSON only, or both HTML and JSON output formats.

```APIDOC
## Configuration Example Comparison

```js
// Generate HTML report only (suitable for offline viewing)
new RsdoctorRspackPlugin({
  output: {
    mode: 'brief',
    options: {
      type: ['html'],
      htmlOptions: {
        reportHtmlName: 'build-report.html',
      },
    },
  },
});

// Generate JSON data only (suitable for uploading to Playground)
new RsdoctorRspackPlugin({
  output: {
    mode: 'brief',
    options: {
      type: ['json'],
    },
  },
});

// Generate both formats (suitable for different use cases)
new RsdoctorRspackPlugin({
  output: {
    mode: 'brief',
    options: {
      type: ['html', 'json'],
      htmlOptions: {
        reportHtmlName: 'build-report.html',
      },
    },
  },
});
```
```

--------------------------------

### Configure cjs-require rule

Source: https://rsdoctor.rs/guide/rules/rules

Defines the configuration interface for ignoring module paths and provides a plugin setup example.

```ts
interface Config {
  /** Module path fragments to ignore */
  ignore: string[];
}
```

```ts
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugins: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'cjs-require': [
            'Warn',
            { ignore: ['legacy-lib', 'node_modules/@internal/'] },
          ],
        },
      },
    }),
  ],
};
```

--------------------------------

### Install @rsdoctor/cli

Source: https://rsdoctor.rs/guide/start/cli

Instructions for installing the @rsdoctor/cli package using various package managers.

```APIDOC
## Install @rsdoctor/cli

This section details how to install the `@rsdoctor/cli` package using different package managers.

### npm
```sh
npm add @rsdoctor/cli -D
```

### yarn
```sh
yarn add @rsdoctor/cli -D
```

### pnpm
```sh
pnpm add @rsdoctor/cli -D
```

### bun
```sh
bun add @rsdoctor/cli -D
```

### deno
```sh
denp add npm:@rsdoctor/cli -D
```

**Note:** Ensure that `@rsdoctor/cli`, `@rsdoctor/webpack-plugin`, and `@rsdoctor/rspack-plugin` share the same major and minor versions. You can also use `npx @rsdoctor/cli <command> [options]` for a non-installation method.
```

--------------------------------

### Install Rsdoctor analysis skill

Source: https://rsdoctor.rs/guide/start/ai

Commands to install the rsdoctor-analysis skill using various package managers.

```sh
npx skills add rstackjs/agent-skills --skill rsdoctor-analysis
```

```sh
yarn dlx skills add rstackjs/agent-skills --skill rsdoctor-analysis
```

```sh
pnpm dlx skills add rstackjs/agent-skills --skill rsdoctor-analysis
```

```sh
bunx skills add rstackjs/agent-skills --skill rsdoctor-analysis
```

```sh
deno run -A npm:skills add rstackjs/agent-skills --skill rsdoctor-analysis
```

--------------------------------

### Access Markdown documentation

Source: https://rsdoctor.rs/guide/start/ai

Example URL for accessing a specific documentation page in Markdown format.

```text
https://rsdoctor.rs/guide/start/intro.md
```

--------------------------------

### Configure module-mixed-chunks rule

Source: https://rsdoctor.rs/guide/rules/rules

Defines the configuration interface for ignoring module paths and provides a plugin setup example.

```ts
interface Config {
  /** Module path fragments to ignore */
  ignore: string[];
}
```

```ts
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugin: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'module-mixed-chunks': ['Warn', { ignore: ['node_modules/'] }],
        },
      },
    }),
  ],
};
```

--------------------------------

### Configure tree-shaking-side-effects-only rule

Source: https://rsdoctor.rs/guide/rules/rules

Defines the configuration interface for ignoring or including specific module paths and provides a plugin setup example.

```ts
interface Config {
  /** Module path fragments to ignore */
  ignore: string[];
  /**
   * Module path patterns to include when the module is under node_modules.
   * Example: ['react', '@babel/runtime']
   */
  include: string[];
}
```

```ts
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugins: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'tree-shaking-side-effects-only': [
            'Warn',
            {
              ignore: ['src/polyfills'],
              include: ['some-lib'],
            },
          ],
        },
      },
    }),
  ],
};
```

--------------------------------

### Example project structure with .bundle files

Source: https://rsdoctor.rs/llms-full.txt

Rsdoctor automatically detects and analyzes files with the .bundle extension, commonly used in Re.Pack projects.

```text
dist/
  ├── index.bundle        ← Now supported!
  ├── vendor.bundle       ← Now supported!
  ├── styles.css
  └── assets/
```

--------------------------------

### Install @rsdoctor/core dependency

Source: https://rsdoctor.rs/guide/rules/rule-custom

Install the core package required for defining custom rules.

```sh
npm add @rsdoctor/core -D
```

```sh
yarn add @rsdoctor/core -D
```

```sh
pnpm add @rsdoctor/core -D
```

```sh
bun add @rsdoctor/core -D
```

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

--------------------------------

### Configure Rsdoctor to use Brief mode

Source: https://rsdoctor.rs/config/options/brief

Example of initializing `RsdoctorRspackPlugin` with Brief mode enabled. Use this to generate a concise HTML report.

```javascript
new RsdoctorRspackPlugin({
  output: {
    mode: 'brief',
  },
});
```

--------------------------------

### Analyze Command Usage

Source: https://rsdoctor.rs/guide/start/cli

Command to load a manifest.json file locally and start the analysis report page.

```bash
rsdoctor analyze --profile <manifestFile>
```

```bash
rsdoctor analyze --profile "./dist/.rsdoctor/manifest.json"
```

--------------------------------

### Install @rsdoctor/cli with pnpm

Source: https://rsdoctor.rs/llms-full.txt

Install the Rsdoctor CLI package as a development dependency using pnpm.

```sh
pnpm add @rsdoctor/cli -D
```

--------------------------------

### Rsdoctor Plugin Configuration Example

Source: https://rsdoctor.rs/guide/rules/rules

An example of how to configure the RsdoctorRspackPlugin to use the 'esm-resolved-to-cjs' rule with specific ignore patterns.

```typescript
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugins: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'esm-resolved-to-cjs': [
            'Warn',
            { ignore: ['my-legacy-pkg', '@internal/'] },
          ],
        },
      },
    }),
  ],
};
```

--------------------------------

### Install @rsdoctor/cli with npm

Source: https://rsdoctor.rs/llms-full.txt

Install the Rsdoctor CLI package as a development dependency using npm.

```sh
npm add @rsdoctor/cli -D
```

--------------------------------

### Install @rsdoctor/cli with yarn

Source: https://rsdoctor.rs/llms-full.txt

Install the Rsdoctor CLI package as a development dependency using yarn.

```sh
yarn add @rsdoctor/cli -D
```

--------------------------------

### Install @rsdoctor/cli

Source: https://rsdoctor.rs/guide/start/cli

Commands to install the Rsdoctor CLI as a development dependency using various package managers.

```sh
npm add @rsdoctor/cli -D
```

```sh
yarn add @rsdoctor/cli -D
```

```sh
pnpm add @rsdoctor/cli -D
```

```sh
bun add @rsdoctor/cli -D
```

```sh
deno add npm:@rsdoctor/cli -D
```

--------------------------------

### Configure RsdoctorRspackPlugin features

Source: https://rsdoctor.rs/config/options/features

Examples showing how to enable specific features using an array or disable specific features using an object.

```js
new RsdoctorRspackPlugin({
  // Only enable bundle, loader, plugins feature analysis, array form will override default configuration.
  features: ['bundle', 'loader', 'plugins'],
});
```

```js
new RsdoctorRspackPlugin({
  features: {
    // Disable bundle analysis, other feature analysis remains default
    bundle: false,
  },
});
```

--------------------------------

### Configure Rsdoctor Brief Mode Output

Source: https://rsdoctor.rs/config/options/output

Example of configuring the RsdoctorRspackPlugin to generate both HTML and JSON reports in brief mode.

```js
new RsdoctorRspackPlugin({
  output: {
    mode: 'brief',
    options: {
      // Output both HTML and JSON formats
      type: ['html', 'json'],
      htmlOptions: {
        reportHtmlName: 'my-report.html',
      },
    },
  },
});
```

--------------------------------

### Run Rsdoctor Local Build

Source: https://rsdoctor.rs/llms-full.txt

Enable Rsdoctor and run a local build. Do not use MCP Client to start the project, as Rsdoctor's local service will block the MCP Client's dialogue process.

```bash
npm run build
```

--------------------------------

### Configure cjs-require Rule

Source: https://rsdoctor.rs/llms-full.txt

Example usage of the RsdoctorRspackPlugin to configure the cjs-require linter rule.

```ts
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugins: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'cjs-require': [
            'Warn',
            { ignore: ['legacy-lib', 'node_modules/@internal/'] },
          ],
        },
      },
    }),
  ],
};
```

--------------------------------

### Initialize RsdoctorRspackPlugin (CJS)

Source: https://rsdoctor.rs/config/options/options

Import and instantiate the RsdoctorRspackPlugin using CommonJS module syntax. This is commonly used in older Node.js environments or specific build setups.

```js
const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');

new RsdoctorRspackPlugin({
  /** RsdoctorRspackPluginOptions */
});
```

--------------------------------

### GitHub Workflow for Bundle Analysis

Source: https://rsdoctor.rs/guide/start/action

Set up a GitHub Actions workflow to automatically perform bundle analysis on pull requests and push events. This workflow checks out code, sets up Node.js and pnpm, installs dependencies, builds the project, and runs the Rsdoctor action for analysis.

```yaml
name: Bundle Analysis

on:
  pull_request:
    types: [opened, synchronize, reopened]
  push:
    branches:
      - main # or your target branch name
  workflow_dispatch: # Optional, allows manual triggering
    inputs:
      target_branch:
        description: 'Target branch to compare against'
        required: false
        default: 'main'
        type: string

jobs:
  bundle-analysis:
    runs-on: ubuntu-latest

    permissions:
      # Allow commenting on commits
      contents: write
      # Allow commenting on issues
      issues: write
      # Allow commenting on pull requests
      pull-requests: write
      # Allow reading workflow runs and downloading artifacts for baseline comparison
      actions: read

    steps:
      - name: Checkout
        uses: actions/checkout@08eba0b27e820071cde6df949e0eba9ba4906955 # v4
        with:
          fetch-depth: 0
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup Pnpm
        run: |
          npm install -g corepack@latest --force
          corepack enable

      - name: Setup Node.js
        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version: 22
          cache: 'pnpm'

      - name: Install Dependencies and Build
        run: |
          pnpm install
          pnpm run build

      - name: Bundle Analysis
        uses: web-infra-dev/rsdoctor-action@main
        with:
          file_path: 'dist/.rsdoctor/rsdoctor-data.json'
          # Default 'main'. If you want to use a dynamic target branch, i.e., automatically get the target branch of the current pull request instead of a fixed main branch, you can use the following configuration:
          # ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
          target_branch: 'main'
          # Target branch for manual trigger
          dispatch_target_branch: ${{ github.event.inputs.target_branch }}
```

--------------------------------

### Report rule details

Source: https://rsdoctor.rs/llms-full.txt

Examples of reporting rule results using the report function with different detail types.

```js
report({
  message: 'The count of assets is bigger than limit',
  detail: {
    // ......
    description: 'The count of assets is bigger than limit',
  },
});
```

```js
report({
  detail: {
    // ......
    link: 'http://....',
  },
});
```

```ts
report({
  message: 'The count of assets is bigger than limit',
  detail: {
    type: 'link',
    link: 'https://rsdoctor.rs/zh/guide/start/quick-start', // This link just for show case.
  },
});
```

```js
  const detail {
    type: 'code-view',
    file: {
      path: document.path,
      content: document.content,
      ranges: [node.loc!],
    },
  };

  report({
    message,
    document,
    detail,
  });
```

--------------------------------

### CLI analyze command

Source: https://rsdoctor.rs/llms-full.txt

The analyze command loads a manifest.json file locally to start the Rsdoctor analysis report page without requiring a rebuild.

```APIDOC
## analyze

### Description
Loads a manifest.json file locally and starts the Rsdoctor analysis report page.

### Parameters
#### Arguments
- **manifestFile** (string) - Required - The path to the manifest.json file.

### Usage Example
rsdoctor analyze --profile "./dist/.rsdoctor/manifest.json"
```

--------------------------------

### Install Rsdoctor for Rspack Projects (bun)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Rspack plugin to your Rspack-based projects like Rsbuild or Rslib when using bun.

```sh
bun add @rsdoctor/rspack-plugin -D
```

--------------------------------

### Install Rsdoctor for Rspack Projects (deno)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Rspack plugin to your Rspack-based projects like Rsbuild or Rslib when using deno.

```sh
deno add npm:@rsdoctor/rspack-plugin -D
```

--------------------------------

### Install Rsdoctor for Rspack Projects

Source: https://rsdoctor.rs/llms-full.txt

Use this command to add the Rsdoctor Rspack plugin to your Rspack-based projects. It's typically installed as a development dependency.

```sh
npm add @rsdoctor/rspack-plugin -D
```

```sh
yarn add @rsdoctor/rspack-plugin -D
```

```sh
pnpm add @rsdoctor/rspack-plugin -D
```

```sh
bun add @rsdoctor/rspack-plugin -D
```

```sh
deno add npm:@rsdoctor/rspack-plugin -D
```

--------------------------------

### Install Rsdoctor for Webpack Projects (deno)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Webpack plugin to your Webpack projects. Rsdoctor requires webpack version 5 or higher.

```sh
deno add npm:@rsdoctor/webpack-plugin -D
```

--------------------------------

### Register Rsdoctor in Rsbuild

Source: https://rsdoctor.rs/guide/start/quick-start

Example configuration for integrating Rsdoctor into an Rsbuild project.

```ts
import { defineConfig } from '@rsbuild/core';
import { pluginVue } from '@rsbuild/plugin-vue';
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default defineConfig({
  plugins: [pluginVue()],
  performance: {
    buildCache: false,
  },
  tools: {
    bundlerChain: (chain, { CHAIN_ID }) => {
      chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
        {
          // plugin options
        },
      ]);
    },
  },
});
```

--------------------------------

### Install Rsdoctor for Webpack Projects (bun)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Webpack plugin to your Webpack projects. Rsdoctor requires webpack version 5 or higher.

```sh
bun add @rsdoctor/webpack-plugin -D
```

--------------------------------

### Configure Tree Shaking Side Effects Rule

Source: https://rsdoctor.rs/llms-full.txt

Example of configuring the 'tree-shaking-side-effects-only' linter rule. It demonstrates how to use 'ignore' to exclude specific paths and 'include' to target modules within node_modules.

```typescript
import {
  RsdoctorRspackPlugin,
} from '@rsdoctor/rspack-plugin';

export default {
  plugins: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'tree-shaking-side-effects-only': [
            'Warn',
            {
              ignore: ['src/polyfills'],
              include: ['some-lib'],
            },
          ],
        },
      },
    }),
  ],
};
```

--------------------------------

### Enable Rsdoctor Brief Mode in Rspack

Source: https://rsdoctor.rs/guide/start/cicd

Configure the RsdoctorRspackPlugin to use 'brief' mode by setting the 'mode' option. This setup is typically conditional, often based on an environment variable like RSDOCTOR.

```javascript
const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');

module.exports = {
  // ...
  plugins: [
    process.env.RSDOCTOR &&
      new RsdoctorRspackPlugin({
        // other options
        mode: 'brief',
      }),
  ].filter(Boolean),
};
```

--------------------------------

### Disabling a Linter Rule Example

Source: https://rsdoctor.rs/guide/rules/rules

Demonstrates how to disable a specific linter rule, 'duplicate-package' in this case, by setting its severity input to 'off'.

```typescript
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugin: [
    new RsdoctorRspackPlugin({
      linter: {
        level: 'Error',
        extends: [],
        rules: {
          'duplicate-package': 'off',
        },
      },
    }),
  ],
};
```

--------------------------------

### Configure Custom Rule in Rsbuild

Source: https://rsdoctor.rs/blog/release/release-note-0_3

Integrate a custom Rsdoctor rule, 'assets-count-limit', into Rsbuild configuration. This example sets a custom limit of 1 for the asset count rule.

```typescript
// rsbuild.config.ts
import { AssetsCountLimit } from './rules/assets-count-limit';

export default {
  tools: {
    bundlerChain: (chain) => {
      chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
        {
          linter: {
            level: 'Error',
            extends: [AssetsCountLimit],
            rules: {
              'assets-count-limit': [
                'on',
                {
                  limit: 1, // rule custom configs
                },
              ],
            },
          },
        },
      ]);
    },
  },
};
```

--------------------------------

### Install Rsdoctor for Rspack Projects (pnpm)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Rspack plugin to your Rspack-based projects like Rsbuild or Rslib when using pnpm.

```sh
pnpm add @rsdoctor/rspack-plugin -D
```

--------------------------------

### Install Rsdoctor for Webpack Projects (pnpm)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Webpack plugin to your Webpack projects. Rsdoctor requires webpack version 5 or higher.

```sh
pnpm add @rsdoctor/webpack-plugin -D
```

--------------------------------

### Install Rsdoctor for Webpack Projects (npm)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Webpack plugin to your Webpack projects. Rsdoctor requires webpack version 5 or higher.

```sh
npm add @rsdoctor/webpack-plugin -D
```

--------------------------------

### Install Rsdoctor for Rspack Projects (yarn)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Rspack plugin to your Rspack-based projects like Rsbuild or Rslib when using yarn.

```sh
yarn add @rsdoctor/rspack-plugin -D
```

--------------------------------

### Install Rsdoctor for Rspack Projects (npm)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Rspack plugin to your Rspack-based projects like Rsbuild or Rslib when using npm.

```sh
npm add @rsdoctor/rspack-plugin -D
```

--------------------------------

### Execute Build Commands

Source: https://rsdoctor.rs/guide/start/quick-start

Run the build process using various package managers.

```sh
npm run build
```

```sh
yarn run build
```

```sh
pnpm run build
```

```sh
bun run build
```

```sh
deno run npm:build
```

--------------------------------

### Install Rsdoctor for Webpack Projects (yarn)

Source: https://rsdoctor.rs/guide/start/quick-start

Use this command to add the Rsdoctor Webpack plugin to your Webpack projects. Rsdoctor requires webpack version 5 or higher.

```sh
yarn add @rsdoctor/webpack-plugin -D
```

--------------------------------

### Configure Rsdoctor Plugin with Linter Rules

Source: https://rsdoctor.rs/llms-full.txt

Example of configuring the RsdoctorRspackPlugin with custom linter rules, including 'module-mixed-chunks'. The 'ignore' option can be used to specify module path patterns to exclude from checks.

```typescript
import {
  RsdoctorRspackPlugin,
} from '@rsdoctor/rspack-plugin';

export default {
  plugin: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'module-mixed-chunks': ['Warn', { ignore: ['node_modules/'] }],
        },
      },
    }),
  ],
};
```

--------------------------------

### Execute Build Command with Bun

Source: https://rsdoctor.rs/llms-full.txt

Run the build command using Bun. Rsdoctor will generate report data locally.

```sh
bun run build
```

--------------------------------

### Configure Analysis Scripts

Source: https://rsdoctor.rs/guide/start/quick-start

Add scripts to package.json to open client and server reports.

```ts
  "scripts": {
    "client:rsd": "rsdoctor analyze --profile .next/.rsdoctor/manifest.json", // Rsdoctor's client report
    "server:rsd": "rsdoctor analyze --profile .next/server/.rsdoctor/manifest.json" // Rsdoctor's server report
  }
```

--------------------------------

### Execute Build Command with Deno

Source: https://rsdoctor.rs/llms-full.txt

Run the build command using Deno. Rsdoctor will generate report data locally.

```sh
deno run npm:build
```

--------------------------------

### Project Directory Structure

Source: https://rsdoctor.rs/llms-full.txt

A representation of a pnpm workspace directory structure showing how peer dependencies can lead to multiple instances of the same package.

```txt
├── node_modules
├── apps
│   └── web
│       ├── node_modules
│       │   ├── component  ->  ../../packages/component
│       │   ├── axios      ->  ../../../node_modules/.pnpm/axios@0.27.2_debug@4.3.4
│       │   └── debug      ->  ../../../node_modules/.pnpm/debug@4.3.4
│       ├── src
│       │   └── index.js
│       ├── rspack.config.js
│       └── package.json
└── packages
    └── component
        ├── node_modules
        │   └── axios      ->  ../../../node_modules/.pnpm/axios@0.27.2
        ├── src
        │   └── index.js
        └── package.json
```

--------------------------------

### Analyze Report via CLI

Source: https://rsdoctor.rs/guide/start/quick-start

Manually open a report page by pointing to the manifest file.

```bash
rsdoctor analyze --profile .next/server/chunks/.rsdoctor/manifest.json
```

--------------------------------

### Brief Configuration Options

Source: https://rsdoctor.rs/config/options/brief

Configuration details for the Brief mode, including reportHtmlName and writeDataJson settings.

```APIDOC
## Brief Configuration

### Description
Configures the Brief mode for the Rsdoctor Rspack plugin. Note: This is deprecated in V2; use output.mode: 'brief' instead.

### Parameters
- **reportHtmlName** (string) - Optional - Configures the filename of the HTML report. Default: 'report-rsdoctor.html'.
- **writeDataJson** (boolean) - Optional - If true, generates additional local JSON data files. Default: false.

### Request Example
```js
new RsdoctorRspackPlugin({
  output: {
    mode: 'brief',
  },
});
```
```

--------------------------------

### Install Rsdoctor for Webpack Projects

Source: https://rsdoctor.rs/llms-full.txt

Use this command to add the Rsdoctor Webpack plugin to your Webpack projects. Rsdoctor supports webpack version 5 and above. It's installed as a development dependency.

```sh
npm add @rsdoctor/webpack-plugin -D
```

```sh
yarn add @rsdoctor/webpack-plugin -D
```

```sh
pnpm add @rsdoctor/webpack-plugin -D
```

```sh
bun add @rsdoctor/webpack-plugin -D
```

```sh
deno add npm:@rsdoctor/webpack-plugin -D
```

--------------------------------

### Bundle-Diff Command Usage

Source: https://rsdoctor.rs/guide/start/cli

Command to compare two manifest.json files for bundle analysis.

```bash
rsdoctor bundle-diff --baseline <baselineManifestJsonPath> --current <currentManifestJsonPath>
```

```bash
rsdoctor bundle-diff --baseline="baseline/.rsdoctor/manifest.json" --current="current/.rsdoctor/manifest.json"
```

--------------------------------

### Access llms.txt documentation files

Source: https://rsdoctor.rs/guide/start/ai

URLs for accessing the structured index and full-content documentation files for AI consumption.

```text
https://rsdoctor.rs/llms.txt
```

```text
https://rsdoctor.rs/llms-full.txt
```

--------------------------------

### Define SourceRange Interface

Source: https://rsdoctor.rs/guide/rules/rule-custom

Represents a range within source code, defined by start and optional end positions.

```typescript
/** Source code range */
interface SourceRange {
  start: SourcePosition;
  end?: SourcePosition;
}
```

--------------------------------

### Execute Build Command with Yarn

Source: https://rsdoctor.rs/llms-full.txt

Run the build command using Yarn. Rsdoctor will generate report data locally.

```sh
yarn run build
```

--------------------------------

### Disable Parse Bundle Analysis

Source: https://rsdoctor.rs/config/options/supports

Example configuration to disable the parseBundle capability within the RsdoctorRspackPlugin to reduce build time in large repositories.

```ts
chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
  {
    supports: {
      parseBundle: false,
    },
  },
]);
```

--------------------------------

### Execute Build Command with pnpm

Source: https://rsdoctor.rs/llms-full.txt

Run the build command using pnpm. Rsdoctor will generate report data locally.

```sh
pnpm run build
```

--------------------------------

### Enable Native Plugin for Faster Analysis

Source: https://rsdoctor.rs/blog/release/release-note-1_0

Enable Rust-based native plugins for improved build analysis performance. This optimization can reduce overall analysis time by over 20%.

```typescript
new RsdoctorRspackPlugin({
  experiments: {
    enableNativePlugin: true,
  },
});
```

--------------------------------

### Brief Configuration Interface

Source: https://rsdoctor.rs/config/options/brief

Defines the structure for Brief mode configuration. `reportHtmlName` sets the HTML report filename, and `writeDataJson` (deprecated) controls the generation of JSON data files.

```typescript
interface BriefConfig {
  reportHtmlName?: string | undefined;
  writeDataJson: boolean;
}
```

--------------------------------

### Initialize RsdoctorRspackPlugin (ESM)

Source: https://rsdoctor.rs/config/options/options

Import and instantiate the RsdoctorRspackPlugin using ECMAScript module syntax. This is typically done in your Rspack configuration file.

```ts
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

new RsdoctorRspackPlugin({
  /** RsdoctorRspackPluginOptions */
});
```

--------------------------------

### Initialize RsdoctorWebpackPlugin (CJS)

Source: https://rsdoctor.rs/config/options/options

Import and instantiate the RsdoctorWebpackPlugin using CommonJS module syntax. This is suitable for projects that primarily use CommonJS modules.

```js
const { RsdoctorWebpackPlugin } = require('@rsdoctor/webpack-plugin');

new RsdoctorWebpackPlugin({
  /** RsdoctorWebpackPluginOptions */
});
```

--------------------------------

### CLI bundle-diff command

Source: https://rsdoctor.rs/llms-full.txt

The bundle-diff command compares two manifest.json files to analyze differences between build bundles.

```APIDOC
## bundle-diff

### Description
Loads two manifest.json files locally and opens the Rsdoctor Bundle Diff page for comparison.

### Parameters
#### Options
- **--baseline** (string) - Required - Path to the manifest.json used as the baseline.
- **--current** (string) - Required - Path to the manifest.json used as the current version for comparison.

### Usage Example
rsdoctor bundle-diff --baseline="baseline/.rsdoctor/manifest.json" --current="current/.rsdoctor/manifest.json"
```

--------------------------------

### Plugin Configuration Options

Source: https://rsdoctor.rs/config/options/options

Configuration properties available for both RsdoctorRspackPlugin and RsdoctorWebpackPlugin.

```APIDOC
## Configuration Options

### Parameters
- **disableClientServer** (boolean) - Optional - Whether to not automatically open the Rsdoctor report service.
- **experiments** (object) - Optional - Experimental features (Rspack only).
- **features** (array/object) - Optional - Control analysis features like loader or bundle analysis.
- **output** (object) - Optional - Control report output format and directory.
- **port** (number) - Optional - Port number for the development server.
- **mode** (string) - Optional - Build report output mode ('brief' | 'normal').
```

--------------------------------

### Output Format Comparison

Source: https://rsdoctor.rs/config/options/output

Compares the features, usage, data completeness, file size, use cases, and dependencies of HTML and JSON output formats.

```APIDOC
## HTML vs JSON Output Format Differences

| Feature               | HTML Format                                                                                      | JSON Format                                                                                |
| --------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| **File Structure**    | Single file containing complete analysis report page                                             | Pure data file requiring client support                                                    |
| **Usage**             | Can be opened directly in browser for viewing                                                    | Needs to be uploaded to Playground or parsed with client                                   |
| **Data Completeness** | Contains all analysis data and visualization interface                                           | Contains only raw analysis data                                                            |
| **File Size**         | Larger (includes styles and scripts)                                                             | Smaller (data only)                                                                        |
| **Use Cases**         | • Offline report viewing<br />• Direct sharing with others<br />• No secondary processing needed | • Upload to Playground<br />• Programmatic processing<br />• Data analysis and integration |
| **Dependencies**      | Self-contained, no external dependencies                                                         | Requires Rsdoctor client support                                                           |

> For viewing analysis reports in Playground, see [Playground](/guide/start/playground.md).
```

--------------------------------

### Configure MCP Server

Source: https://rsdoctor.rs/guide/usage/mcp

Configuration format for adding the Rsdoctor MCP server to various development environments.

```json
{
  "mcpServers": {
    "rsdoctor": {
      "command": "npx",
      "args": ["-y", "@rsdoctor/mcp-server@latest"]
    }
  }
}
```

--------------------------------

### Bundle diff command usage

Source: https://rsdoctor.rs/llms-full.txt

Use the bundle-diff command to compare two manifest.json files locally and open the Rsdoctor Bundle Diff page.

```bash
rsdoctor bundle-diff --baseline <baselineManifestJsonPath> --current <currentManifestJsonPath>
```

--------------------------------

### Enable Rsdoctor with npm build

Source: https://rsdoctor.rs/llms-full.txt

Execute the npm build command with Rsdoctor enabled using an environment variable.

```bash
# Enable Rsdoctor
RSDOCTOR=true npm run build
```

--------------------------------

### Report Link Type for Rsdoctor Rule

Source: https://rsdoctor.rs/guide/rules/rule-custom

Example of using the `report` function to send a 'link' type detail for a rule violation. This is used by Rsdoctor's display components to show additional information, such as a URL.

```typescript
report({
  message: 'The count of assets is bigger than limit',
  detail: {
    type: 'link',
    link: 'https://rsdoctor.rs/zh/guide/start/quick-start',
  },
});
```

--------------------------------

### Configuration: supports

Source: https://rsdoctor.rs/config/options/supports

Details on the supports configuration object and its properties for controlling Rsdoctor analysis features.

```APIDOC
## Configuration: supports

### Description
Configures whether Rsdoctor enables support for specific analysis capabilities.

### Parameters
#### Request Body
- **supports** (object) - Optional - Configuration object for feature analysis.
  - **banner** (boolean) - Optional - Enables compatibility logic for BannerPlugin. Default: true. Note: For debugging only.
  - **parseBundle** (boolean) - Optional - Enables bundle parsing analysis. Default: true. Disabling this improves performance in large repositories but hides Bundled Size and Bundled Code data.
  - **generateTileGraph** (boolean) - Deprecated - Tree Map graphs are now generated by default.

### Request Example
```ts
chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
  {
    supports: {
      parseBundle: false,
      banner: false
    },
  },
]);
```
```

--------------------------------

### Report Code View Type for Rsdoctor Rule

Source: https://rsdoctor.rs/guide/rules/rule-custom

Example demonstrating how to report a 'code-view' type detail using the `report` function. This is useful for highlighting specific code locations related to a rule violation, including file path, content, and ranges.

```javascript
const detail {
  type: 'code-view',
  file: {
    path: document.path,
    content: document.content,
    ranges: [node.loc!],
  },
};

report({
  message,
  document,
  detail,
});

```

--------------------------------

### Enable Rsdoctor Build

Source: https://rsdoctor.rs/guide/usage/mcp

Set the environment variable to enable Rsdoctor during the local build process.

```bash
RSDOCTOR=true npm run build
```

--------------------------------

### Configure Rspack Resolve Alias for React

Source: https://rsdoctor.rs/blog/topic/duplicate-pkg-problem

When dealing with duplicate React versions in a pnpm workspace, configure Rspack's resolve.alias to point to a single, consistent React installation within the project's node_modules. This ensures only one version of React is included in the final build.

```javascript
// apps/web/rspack.config.js
const path = require('path');

module.exports = {
  //...
  resolve: {
    alias: {
      react: path.dirname(require.resolve('react/package.json')),
    },
  },
};
```

--------------------------------

### BriefConfig Type Definition

Source: https://rsdoctor.rs/config/options/output

Configuration for HTML output, including the report filename and an option to additionally write data to JSON files.

```typescript
interface BriefConfig {
  /** HTML report filename, defaults to report-rsdoctor.html */
  reportHtmlName?: string;
  /** Whether to additionally generate JSON data files, defaults to false */
  writeDataJson: boolean;
}
```

--------------------------------

### RsdoctorRspackPluginOptions Interface

Source: https://rsdoctor.rs/config/options/options

Defines the configuration options for the RsdoctorRspackPlugin. Includes settings for linting, features, output mode, client server behavior, and experiments.

```ts
interface RsdoctorWebpackPluginOptions<
  Rules extends LinterType.ExtendRuleData[],
> {
  /** Linter configuration */
  linter?: LinterType.Options<Rules, InternalRules>;

  /** Rsdoctor feature toggles */
  features?:
    | Plugin.RsdoctorWebpackPluginFeatures
    | Array<keyof Plugin.RsdoctorWebpackPluginFeatures>;

  /**
   * @deprecated Use `output.mode` instead. If using `lite` mode, please use `output.reportCodeType: 'noCode' or 'noAssetsAndModuleSource'` instead
   * Rsdoctor mode options:
   * - normal: Normal mode
   * - brief: Brief mode, only displays duration analysis and build artifact analysis results, does not display any code parts
   */
  mode?: 'brief' | 'normal' | 'lite';

  disableClientServer?: boolean;

  supports?: ISupport;

  port?: number;

  /**
   * @deprecated Use `output.options.htmlOptions` instead
   */
  brief?: Config.BriefConfig;

  output?: Config.IOutput<'brief' | 'normal'>;

  experiments?: RsdoctorRspackPluginExperiments;
}

interface RsdoctorRspackPluginExperiments {
  /**
   * Whether to enable native plugin to improve performance
   * @default true
   */
  enableNativePlugin?: boolean;
}
```

--------------------------------

### RsdoctorRspackPluginOptions

Source: https://rsdoctor.rs/llms-full.txt

Configuration options for the RsdoctorRspackPlugin.

```APIDOC
## RsdoctorRspackPluginOptions

### Description
Configuration options for the RsdoctorRspackPlugin.

### Type
Object

### Properties
- **linter** (LinterType.Options<Rules, InternalRules>) - Optional - Linter configuration.
- **features** (Plugin.RsdoctorWebpackPluginFeatures | Array<keyof Plugin.RsdoctorWebpackPluginFeatures>) - Optional - Rsdoctor feature toggles.
- **mode** ('brief' | 'normal' | 'lite') - Optional - Rsdoctor mode options: normal, brief, or lite. `lite` mode is deprecated and should use `output.reportCodeType` instead.
- **disableClientServer** (boolean) - Optional - Whether to not automatically open the Rsdoctor report service after analysis is complete.
- **supports** (ISupport) - Optional - Feature support configuration for specific build tools.
- **port** (number) - Optional - Set the port number for the Rsdoctor development server.
- **brief** (Config.BriefConfig) - Optional - Deprecated. Use `output.options.htmlOptions` instead. Control the generation of brief mode reports.
- **output** (Config.IOutput<'brief' | 'normal'>) - Optional - Output related configuration, including mode, options, reportCodeType, etc.
- **experiments** (RsdoctorRspackPluginExperiments) - Optional - Experimental features configuration.

### RsdoctorRspackPluginExperiments

#### Description
Experiments configuration for RsdoctorRspackPlugin.

#### Properties
- **enableNativePlugin** (boolean) - Optional - Whether to enable native plugin to improve performance. Defaults to true.
```

--------------------------------

### RsdoctorWebpackPluginOptions

Source: https://rsdoctor.rs/llms-full.txt

Configuration options for the RsdoctorWebpackPlugin.

```APIDOC
## RsdoctorWebpackPluginOptions

### Description
RsdoctorWebpackPlugin is equivalent to `Omit<RsdoctorRspackPluginOptions, 'experiments'>` type.

### Type
Object

### Properties
- **linter** (LinterType.Options<Rules, InternalRules>) - Optional - Linter configuration.
- **features** (Plugin.RsdoctorWebpackPluginFeatures | Array<keyof Plugin.RsdoctorWebpackPluginFeatures>) - Optional - Rsdoctor feature toggles.
- **mode** ('brief' | 'normal' | 'lite') - Optional - Rsdoctor mode options: normal, brief, or lite. `lite` mode is deprecated and should use `output.reportCodeType` instead.
- **disableClientServer** (boolean) - Optional - Whether to not automatically open the Rsdoctor report service after analysis is complete.
- **supports** (ISupport) - Optional - Feature support configuration for specific build tools.
- **port** (number) - Optional - Set the port number for the Rsdoctor development server.
- **brief** (Config.BriefConfig) - Optional - Deprecated. Use `output.options.htmlOptions` instead. Control the generation of brief mode reports.
- **output** (Config.IOutput<'brief' | 'normal'>) - Optional - Output related configuration, including mode, options, reportCodeType, etc.
```

--------------------------------

### Reporting Code Position Workflow

Source: https://rsdoctor.rs/guide/rules/rule-custom

Demonstrates how to report code positions, prioritizing source code over transformed code using SourceMap.

```typescript
const module: SDK.ModuleInstance;
const node: Node.ImportDeclaration;
/** The default type is optional, but in reality, they all have values */
const transformedRange = node.loc!;
/** If the module's SourceMap is not available, this value is null */
const sourceRange = module.getSourceRange(transformedRange);
/** Get the code */
const source = mod.getSource();

// Determine which value to use based on whether the original position is generated
const range = (sourceRange ?? transformed) as Linter.Range;
const content = sourceRange ? source.source : source.transformed;

report({
  document: {
    path: module.path,
    content,
    range,
  },
});
```

--------------------------------

### CLI Command Syntax

Source: https://rsdoctor.rs/guide/start/cli

General syntax for executing Rsdoctor CLI commands.

```bash
rsdoctor <command> [options]
```

--------------------------------

### Report Bootstrap duration

Source: https://rsdoctor.rs/guide/usage/compile-overall

Reports the process uptime as the duration when the compiler.hooks.beforeCompile hook is triggered.

```javascript
process.uptime()
```

--------------------------------

### AST Processing Utilities

Source: https://rsdoctor.rs/guide/rules/rule-custom

Provides utility functions for Abstract Syntax Tree (AST) processing, including parsing, walking, and assertion methods, available via `@rsdoctor/utils/rule-utils`.

```APIDOC
## AST Processing Utilities

When performing rule detection and analysis, it is common to perform AST analysis on modules and other operations. To provide more auxiliary functions, we also provide `@rsdoctor/utils/rule-utils` in the `@rsdoctor/utils` package, which contains many useful utility functions and methods.

```ts
/** This includes the type definitions for all AST nodes */
type Node = /* SyntaxNode */;

interface parser {
  /** AST iterator */
  walk,
  /**
   * Compile code
   *   - The root node is `Node.Program`
   */
  parse,
  /**
   * Compile the next expression
   *   - The root node is `Node.ExpressionStatement`
   */
  parseExpressionAt,
  /** Assertion methods */
  asserts,
  /** Utility methods */
  utils,
}

/** Document class */
interface Document {
  /** Get the position in the text at the given offset */
  positionAt!: (offset: number) => Position | undefined;
  /** Get the position in the file at the given point */
  offsetAt!: (position: Position) => number | undefined;
}
```

The `asserts` assertion method set provides type assertion methods for all AST nodes, while the `utils` utility method set provides commonly used methods such as determining whether certain statements have the same semantics and retrieving Import nodes.
```

--------------------------------

### Configure Rsdoctor for Brief JSON Output

Source: https://rsdoctor.rs/guide/start/playground

Configure Rspack or Webpack to output brief JSON analysis data for uploading to the Playground. Ensure `output.mode` is 'brief' and `output.options.type` includes 'json'.

```javascript
export default {
  plugins: [
    new RsdoctorRspackPlugin({
      output: {
        mode: 'brief',
        options: {
          type: ['json'], // or ['html', 'json']
        },
      },
    }),
  ],
};
```

--------------------------------

### Configure MCP Server Port

Source: https://rsdoctor.rs/llms-full.txt

Set a specific port for the MCP server via command line.

```bash
npx @rsdoctor/mcp-server@latest --port 1000
```

--------------------------------

### Configure Webpack/Rspack stats for analysis

Source: https://rsdoctor.rs/llms-full.txt

Use verbose mode or specific stats options to ensure all necessary build information is captured for Rsdoctor analysis.

```javascript
export default {
  stats: 'verbose',
};
```

```javascript
export default {
  stats: {
    all: false,
    chunks: true,
    assets: true,
    modules: true,
    chunkModules: true,
    hash: true,
    ids: true,
    version: true,
    optimizationBailout: true, // Optional configuration
  },
};
```

--------------------------------

### experiments.enableNativePlugin Option

Source: https://rsdoctor.rs/llms-full.txt

Enables the Rspack native plugin to move data processing to the Rspack build stage, improving analysis efficiency.

```APIDOC
## experiments.enableNativePlugin

### Description
By enabling the enableNativePlugin option, the Rspack native plugin moves the time-consuming data processing logic from Rsdoctor to the Rspack build stage, significantly improving build analysis efficiency and greatly reducing Rsdoctor's own analysis time.

### Method
N/A (Configuration Option)

### Endpoint
N/A (Configuration Option)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```js
new RsdoctorRspackPlugin({
  experiments: { enableNativePlugin: true }
}),
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

### Configuration Details
- **Type:** `boolean`
- **Optional:** `true`
- **Default:** `true`

```

--------------------------------

### Default Import Check Configuration

Source: https://rsdoctor.rs/llms-full.txt

Configuration for the [E1005] Default Import Check rule to handle compatibility issues with CJS modules.

```APIDOC
## [E1005] Default Import Check

### Description
Configures the rule to ignore specific imported files during default import compatibility checks.

### Parameters
#### Request Body
- **ignore** (Array<string>) - Required - List of packages to be ignored.
```

--------------------------------

### Enable Native Plugin in RsdoctorRspackPlugin

Source: https://rsdoctor.rs/config/options/experiments

Configure the RsdoctorRspackPlugin to use the native plugin for improved build analysis efficiency.

```js
new RsdoctorRspackPlugin({
  experiments: { enableNativePlugin: true }
}),
```

--------------------------------

### Configure SourceMap for Bundle Analysis

Source: https://rsdoctor.rs/guide/more/faq

Manually enable SourceMap when Rsdoctor is enabled if you are missing Module drill-down in the Tree Map or Bundled Size data. This configuration should not affect production builds.

```javascript
export default {
  devtool: 'cheap-source-map', // or other devtool configuration
};
```

--------------------------------

### Node API - execute()

Source: https://rsdoctor.rs/guide/start/cli

How to use the `execute` function from the `@rsdoctor/cli` Node.js API to programmatically run Rsdoctor commands.

```APIDOC
## Node API

The `@rsdoctor/cli` package exposes a Node.js API for programmatic use.

### Importing the Module

#### esm
```js
import { execute } from '@rsdoctor/cli';
```

#### cjs
```js
const { execute } = require('@rsdoctor/cli');
```

### execute()

The `execute` function is an asynchronous function that runs Rsdoctor commands by parsing `process.argv`.

#### execute('analyze', {...})

To directly execute the `analyze` command via the Node.js API:

```ts
execute('analyze', {
  profile: 'input the manifest.json path or url',
}).then((sdk) => {
  console.log('execute "analyze" command success');
  // sdk.dispose(); // Optional: to stop Rsdoctor's dev-server
});
```
```

--------------------------------

### Analyze command usage

Source: https://rsdoctor.rs/llms-full.txt

Use the analyze command to load a manifest.json file locally and generate an Rsdoctor analysis report without rebuilding.

```bash
rsdoctor analyze --profile <manifestFile>
```

--------------------------------

### compressData Configuration (Deprecated)

Source: https://rsdoctor.rs/config/options/output

Configuration for compressing analysis data. Deprecated in V2.

```APIDOC
## compressData

:::warning
Deprecated in V2, please use `output.mode: 'brief'` and `output.options.type: 'json'` instead. Refer to [compressData configuration migration](/config/options/options-v2.md#compressdata).
:::

- **Type:** `boolean`
- **Optional:** `true`
- **Default:** `true`

compressData is used to configure whether to compress the analysis data under `[outputDir]/.rsdoctor`.
```

--------------------------------

### Configure Rsdoctor MCP Server Compiler

Source: https://rsdoctor.rs/guide/usage/mcp

Use the --compiler parameter to specify which compiler's build analysis data to target in multi-compiler projects.

```bash
npx @rsdoctor/mcp-server@latest --compiler web
```
Tokens:
Raw