#CI/CD tutorial

Brief mode generates a self-contained report that can be stored as a CI artifact or uploaded to a CDN.

#Enable brief mode

Configure output.mode: 'brief' and include HTML in output.options.type. After the build, Rsdoctor writes rsdoctor-report.html to the report output directory, which defaults to [outputDir] and can be changed with output.reportDir. Open the file directly in a browser to view the report.

• Brief reports omit code data to keep the standalone file manageable.
• Use output.options.htmlOptions.reportHtmlName to change the filename.
• For more options, see mode: 'brief'.

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

export default {
  plugins: [
    process.env.RSDOCTOR &&
      new RsdoctorRspackPlugin({
        output: {
          mode: 'brief',
          options: {
            type: ['html'],
          },
        },
      }),
  ].filter(Boolean),
};

#Report modes

Rsdoctor 2.x supports normal and brief output modes. The legacy lite mode is retained only for backward compatibility.

• normal mode: Generates a .rsdoctor folder in the build output directory, which contains various data files and displays code in the report page. The output directory can be configured via reportDir.

• brief mode: 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 injected into this standalone HTML file, which can be opened directly in a browser. See mode: 'brief' for the available options.

• lite mode: Based on the normal mode, this mode does not display source code and product code, only showing the information of the bundled code.

  • The top-level mode: 'lite' option was removed and is ignored in Rsdoctor 2.x. The features lite configurations remain supported. Use output.reportCodeType for new configurations.