For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /config/options/options-v2.md.
close
  • English

      • Legacy configuration migration

      Rsdoctor 1.2.4 introduced the output configuration used by Rsdoctor 2.x. It is easier to configure and extend than the legacy options.

      The top-level mode and legacy output.compressData options were removed and are ignored in Rsdoctor 2.x. The legacy brief option is deprecated and retained for backward compatibility. Use the table below to migrate these options. Both forms of the features lite configuration remain supported and are included only to show the equivalent output configuration.

      Original ConfigurationNew Configuration
      modeConfigure output.mode instead.
      briefConfigure output.mode: 'brief' and set output.options.type to ['html'].
      output.compressDataConfigure output.mode: 'brief' and set output.options.type to ['json'].
      mode: 'lite'Configure output.mode: 'normal' and set output.reportCodeType to noCode or noAssetsAndModuleSource.
      features: { lite: true } or features: ['lite']Still supported. The equivalent output configuration uses output.mode: 'normal' and output.reportCodeType as above.
      NoneNew output.options.jsonOptions.sections configuration

      Configuration change details

      mode

      The top-level mode option was removed in Rsdoctor 2.x. Use output.mode to keep output-related settings together.

      brief

      The current brief report mode outputs an HTML file as the report page. The new brief mode still supports JSON format, and for unified management of the same configuration, the brief configuration is moved to output.options. Replace the original brief configuration with output.mode: 'brief' and set output.options.type to ['html'].

      output.compressData

      output.compressData was removed and is ignored in Rsdoctor 2.x. Replace it with output.mode: 'brief' and set output.options.type to ['json'].

      lite

      The internal logic of lite mode is equivalent to output.reportCodeType being noCode or noAssetsAndModuleSource, mainly to solve the problem of large projects being too slow when opening reports or OOM during build.

      mode: 'lite' was removed and is ignored in Rsdoctor 2.x. Replace it with output.mode: 'normal', and set output.reportCodeType to noCode or noAssetsAndModuleSource.

      Both features: { lite: true } and features: ['lite'] remain supported and do not need to be migrated. The equivalent output.reportCodeType configuration expresses the intended report content more clearly.

      output.options.jsonOptions.sections

      Use output.options.jsonOptions.sections to control which sections are included in JSON output. See output.options.jsonOptions.sections for the available fields.