#output

#mode

• Type: "normal" | "brief"

Rsdoctor report mode, default is normal.

• normal: Generates a .rsdoctor folder in the build output directory, containing various data files and displaying code in the report page. The output directory can be configured via reportDir.
• brief: Generates rsdoctor-report.html in the report output directory. This directory defaults to the build output directory and can be configured via reportDir. All build analysis data is embedded in this standalone HTML file, which can be opened directly in a browser. See mode: 'brief' for more options.

#options

• Type: BriefModeOptions | NormalModeOptions
• Optional: true
• Default: undefined
• Description: Based on different mode configurations, options supports different configuration items:

#mode: 'brief'

Brief mode is used to generate lightweight analysis reports, supporting both HTML and JSON output formats.

• type: Output type, supports 'html' and 'json' arrays, allowing multiple formats to be selected simultaneously
  • If configured with ['html', 'json'], it will generate both an HTML file and a JSON file.
  • If configured with ['json'], it will generate a JSON file named rsdoctor-data.json.
  • If configured with ['html'], it will generate an HTML file. The filename can be configured via htmlOptions.reportHtmlName.
• htmlOptions: HTML output related configuration
  • reportHtmlName: HTML report filename, defaults to rsdoctor-report.html
• jsonOptions: JSON output related configuration
  • fileName: JSON stats filename, defaults to rsdoctor-data.json
  • sections: Module configuration for JSON output
    • moduleGraph: Whether to include module graph data, defaults to true
    • chunkGraph: Whether to include Chunk graph data, defaults to true
    • rules: Whether to include rules data, defaults to true

Notes:

• In Brief mode, the reportCodeType configuration item is invalid because only 'noCode' is supported.

Configuration Example:

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

#HTML vs JSON output format differences

For viewing analysis reports in Playground, see Playground.

Configuration Example Comparison:

// 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',
      },
    },
  },
});

#mode: 'normal'

In Normal mode, options is an empty object with no additional configuration items.

#Type definitions

#BriefModeOptions

interface BriefModeOptions {
  /** Output type, supports HTML and JSON */
  type?: Array<'html' | 'json'>;
  /** HTML output related configuration */
  htmlOptions?: BriefConfig;
  /** JSON output related configuration */
  jsonOptions?: JsonOptions;
}

interface BriefConfig {
  /** HTML report filename, defaults to rsdoctor-report.html */
  reportHtmlName?: string;
}

interface JsonOptions {
  /** JSON stats filename, defaults to rsdoctor-data.json */
  fileName?: string;
  /** Module configuration for JSON output */
  sections?: JsonSectionOptions;
}

interface JsonSectionOptions {
  /** Whether to include module graph data, defaults to true */
  moduleGraph?: boolean;
  /** Whether to include Chunk graph data, defaults to true */
  chunkGraph?: boolean;
  /** Whether to include rules data, defaults to true */
  rules?: boolean;
}

#NormalModeOptions

NormalModeOptions currently has an empty Object type.

#reportCodeType

• Type: "noModuleSource" | "noAssetsAndModuleSource" | "noCode"
• Rsdoctor 2.x accepts only the string values listed above.
• Optional: true
• Default: undefined, when undefined, outputs all complete data.
• Description: Select the scope of output analysis data:
  • Default: Output all complete data
  • noModuleSource: Output data excluding module (Module) code. Module code refers to the packaged module code of individual files within the Bundle.
  • noAssetsAndModuleSource: Output data excluding module (Module) code and Assets product code
  • noCode: Output data excluding code, i.e., no code is output

#Output data comparison table

Data output order from rich to simple: Default > noModuleSource > noAssetsAndModuleSource > noCode

For the explanation of Asset and Module, see Term.

• Example:

new RsdoctorRspackPlugin({
  output: {
    reportCodeType: 'noModuleSource', // or 'noAssetsAndModuleSource'
  }
}),

#reportDir

• Type: string
• Optional: true
• Default: undefined

The output directory for Rsdoctor reports. By default, it is the build output directory.

#compressData