首页
/ TypeDoc项目中的kindSortOrder在Monorepo环境下的配置要点

TypeDoc项目中的kindSortOrder在Monorepo环境下的配置要点

2025-05-28 21:01:40作者:咎岭娴Homer

TypeDoc作为一款优秀的TypeScript文档生成工具,在处理Monorepo项目结构时,其配置方式与单包项目有所不同。本文重点探讨kindSortOrder参数在Monorepo环境下的正确配置方法。

Monorepo模式的工作原理

当TypeDoc运行在Monorepo模式下时,其内部处理流程分为两个阶段:

  1. 独立转换阶段:TypeDoc会依次进入每个子包目录,独立执行文档转换过程
  2. 合并渲染阶段:将所有子包生成的文档数据进行合并,最终输出统一的文档网站

这种处理机制意味着像kindSortOrder这样影响类型排序的配置项,必须在第一阶段就生效,而不能仅在顶层配置中声明。

正确配置方法

对于Monorepo项目,kindSortOrder等转换阶段的配置需要放在packageOptions字段中,而非直接放在配置文件的根级别。这是因为:

  • 根级别的配置仅在合并渲染阶段生效
  • packageOptions中的配置会应用到每个子包的转换过程

示例配置片段:

{
  "entryPoints": ["packages/*"],
  "entryPointStrategy": "packages",
  "packageOptions": {
    "sort": ["kind"],
    "kindSortOrder": [
      "Reference",
      "Function",
      "Class",
      "Interface",
      // 其他类型...
    ]
  }
}

配置项分类理解

在TypeDoc的Monorepo配置中,配置项可分为两类:

  1. 转换阶段配置:影响类型分析、排序等处理过程的选项,必须放在packageOptions中

    • sort
    • kindSortOrder
    • exclude
    • include
  2. 渲染阶段配置:影响最终输出效果的选项,可放在顶层

    • theme
    • highlightTheme
    • name
    • includeVersion

理解这种区分可以帮助开发者更准确地配置TypeDoc,避免出现配置看似正确但不生效的情况。

总结

在Monorepo项目中使用TypeDoc时,务必注意配置项的生效阶段。对于类型排序相关的kindSortOrder等配置,必须将其置于packageOptions字段内才能确保在每个子包的转换过程中正确应用。这种设计虽然增加了配置的复杂度,但也提供了更精细的控制能力,使开发者能够为每个子包定制不同的文档生成策略。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511