close
  • English
  • supports

    This option controls detailed analysis behavior, such as BannerPlugin compatibility, bundle parsing, and gzip size calculation.

    supportsTypes

    type ISupport = {
      banner?: boolean;
      parseBundle?: boolean;
      generateTileGraph?: boolean;
      gzip?:
        | boolean
        | {
            gzipLevel?: number;
          };
    };
    Danger

    supports.banner option is only used for debugging, do not use it in production.

    • Type: boolean
    • Default: true

    If supports.banner is enabled, Rsdoctor will enable compatibility logic for BannerPlugin. For more details, please refer to: Supports BannerPlugin

    generateTileGraph [Deprecated]

    Deprecated

    Rsdoctor supports generating Tree Map graphs by default, so this option does not need to be configured.

    parseBundle

    • Type: boolean
    • Default: true

    In some large repositories, the execution time of parsing the bundle is too long. Since the Parse Bundle analysis utilizes AST parsing and processing, it can be time-consuming when there are a large number of output files. If this capability is not necessary, it can be selectively disabled using the supports.parseBundle configuration. An example is shown below:

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

    Disabling the Parse Bundle capability will only affect the visibility of the Bundled Size and Bundled Code of the modules in the bundle:

    gzip

    • Type: boolean | { gzipLevel?: number }
    • Default: true

    Controls whether Rsdoctor calculates gzip sizes for assets and modules. This calculation only affects the size data in the Rsdoctor report; it does not modify or compress the build output.

    Gzip size calculation is enabled by default with a compression level of 6. Set gzip to an object to customize gzipLevel, which must be an integer between 0 and 9:

    new RsdoctorRspackPlugin({
      supports: {
        gzip: {
          gzipLevel: 9,
        },
      },
    });

    Set gzip to false to disable gzip size calculation:

    new RsdoctorRspackPlugin({
      supports: {
        gzip: false,
      },
    });