For AI agents: the complete documentation index is available at /zh/llms.txt, the full documentation bundle is available at /zh/llms-full.txt, and this page is available as Markdown at /zh/config/options/options-v2.md.
close
  • 简体中文
  • 旧版配置迁移

    Rsdoctor 1.2.4 引入了 Rsdoctor 2.x 使用的 output 配置。 与旧版配置相比,新配置更易于使用和扩展。

    顶层 modeportbrief 和旧版 output.compressData 配置已在 Rsdoctor 2.x 中移除且会被忽略。请根据下表迁移这些配置。两种 features lite 配置仍受支持,下表仅列出其等价的 output 配置。

    原配置新配置
    mode改为配置 output.mode
    port改为配置 server.port
    brief改为配置 output.mode: 'brief',并将 output.options.type 设置为 ['html']。将 brief.reportHtmlName 迁移至 output.options.htmlOptions.reportHtmlName
    output.compressData改为配置 output.mode: 'brief',并将 output.options.type 设置为 ['json']
    mode: 'lite'改为配置 output.mode: 'normal',并将 output.reportCodeType 设置为 noCodenoAssetsAndModuleSource
    features: { lite: true }features: ['lite']仍受支持。等价的 output 配置为 output.mode: 'normal',并按上一行设置 output.reportCodeType
    新增 output.options.jsonOptions.sections 配置

    配置改动详情

    mode

    顶层 mode 配置已在 Rsdoctor 2.x 中移除。请使用 output.mode 统一管理输出相关配置。

    brief

    顶层 brief 配置已在 Rsdoctor 2.x 中移除。当前 brief 简报模式同时支持 HTML 和 JSON 输出,相关配置统一收敛到 output.options。 将原有的 brief 配置替换为 output.mode: 'brief',并将 output.options.type 设置为 ['html']。将 brief.reportHtmlName 迁移至 output.options.htmlOptions.reportHtmlName

    output.compressData

    output.compressData 已在 Rsdoctor 2.x 中移除且会被忽略。请将其替换为 output.mode: 'brief',并将 output.options.type 设置为 ['json']

    lite

    lite 模式的内部逻辑等同于 output.reportCodeTypenoCodenoAssetsAndModuleSource,主要是为了解决大项目在打开报告时过慢或者构建时 OOM 的问题。

    mode: 'lite' 已在 Rsdoctor 2.x 中移除且会被忽略。请将其替换为 output.mode: 'normal',并将 output.reportCodeType 设置为 noCodenoAssetsAndModuleSource

    features: { lite: true }features: ['lite'] 均仍受支持,无需迁移。等价的 output.reportCodeType 配置能更清晰地表达需要包含的报告内容。

    新增 output.options.jsonOptions.sections

    使用 output.options.jsonOptions.sections 控制 JSON 输出包含的数据分区。可配置字段请参阅 output.options.jsonOptions.sections