#Overview

#RsdoctorRspackPlugin

The RsdoctorRspackPlugin class is exported from @rsdoctor/core. Its configuration type is RsdoctorRspackPluginOptions.

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

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

#Options

Type: Object

This Options object is the configuration for RsdoctorRspackPlugin. It contains the following properties:

• disableClientServer - Report Server Control: Whether to shut down the Rsdoctor report server after analysis is complete.
• features - Feature Toggle Configuration: Control various analysis features of Rsdoctor, such as loader analysis, bundle analysis, rule checking, etc.
• output - Output Related Configuration: Control report output format, directory and other options, including mode, options, reportCodeType, etc.
• server - Report Server Configuration: Configure the Rsdoctor report server, including server.port and server.cors.
• supports - Analysis settings: Control bundle parsing and compressed size calculation.
• multiCompiler - Multi-compiler Configuration: Automatically detect and isolate reports for Rspack MultiCompiler and Rsbuild environments.

#RsdoctorRspackPluginOptions

interface RsdoctorRspackPluginOptions<
  Rules extends LinterType.ExtendRuleData[],
> {
  multiCompiler?: boolean | { group?: string };

  /** Linter configuration */
  linter?: LinterType.Options<Rules, InternalRules>;

  /** Rsdoctor feature toggles */
  features?:
    RsdoctorRspackPluginFeatures | Array<keyof RsdoctorRspackPluginFeatures>;

  disableClientServer?: boolean;

  supports?: ISupport;

  server?: SDK.RsdoctorServerConfig;

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