TypeDoc 符号解析器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,在 AI 助手中安装 @user_3c6cb52e/typedoc-symbol-resolver。
技能介绍
它解决什么问题
在 TypeScript 项目里,符号之间的引用常常是隐式的:一个导出类型可能来自声明合并,一个模块的公开形状可能被 declare module 扩展过。只扫源码文本或只看入口文件,很难判断哪些符号应该进入 API 文档,以及它们最终在 .d.ts 或运行时类型中长什么样。这个技能面向的正是这类问题:把 TypeScript 符号解析和文档生成放到同一套编译器视角里处理。
它是如何工作的
它以 TypeDoc compiler API 为核心解析 TypeScript 符号,并用 ts-morph 做 AST 层操作。实际使用时,它会先确定项目的入口点和 TypeScript compiler options,默认尝试定位 tsconfig.json,再基于这些配置展开符号图。
- 解析导出符号时,会保留符号与参考页之间的链接关系。
- 处理 declaration merging 时,会把分散的声明合并成同一个逻辑实体。
- 追踪 module augmentation,避免增强模块的导出被漏掉或误归到原模块。
- 最终生成互链的参考页,而不是把符号表拍平成静态文本。
适用边界与注意点
它适合已经有明确入口和 TypeScript 配置的项目;如果目录缺少必要的配置,入口点可能无法稳定确定。TypeDoc 依赖 Node.js 环境,且上游文档也说明需要在每个目录中提供配置来指定入口。对于纯 JavaScript、动态类型严重,或通过非标准打包方式暴露类型的场景,解析结果可能不如显式 .d.ts 入口可靠。
使用场景
- 在维护大型 TypeScript 库时,需要生成包含声明合并与模块增强细节的完整 API 参考文档。
- 重构 TypeScript 项目时,排查通过 declare module 进行的隐式模块增强是否影响了公开导出类型。
- 为复杂的 TypeScript 符号定义生成相互链接的参考页,方便团队在代码审查时追踪类型来源。
- 在 CI/CD 流程中配置 TypeDoc,根据 tsconfig.json 自动生成并更新项目的 API 文档。
适合人员
- TypeScript 库作者,希望生成的 API 文档能准确反映复杂的类型关系与声明合并结果。
- 前端架构师,在重构大型项目时需要精准追踪全局模块增强对公开类型的影响。
- 开源项目维护者,需要为外部贡献者提供清晰且可互链的 TypeScript 符号参考指南。