SuperAPI AI 工具集

update-docs

写作与研究

查看项目

更新于 10-16 03:36

技能介绍

用途:校验文档示例是否与组件当前公开 API 同步,并修复发现的问题。用法:执行时传入组件路径或文件夹作为参数;参数为空则先向用户询问。若给出组件路径,则查找其对应文档;若给出文档路径,则查找其描述的组件。组件位于 libs/core/<component>/ 或 libs/platform/<component>/,文档位于 libs/docs/core/<component>/ 或 libs/docs/platform/<component>/。

流程分四个阶段。第一阶段读取组件 .ts 文件,提取 input()、output()、model()、@Input()、@Output() 声明;读取文档组件(如 <component>-docs.component.ts 与 .html)及 examples/ 下全部示例文件。第二阶段审计:检查每个公开 input/output/model 是否至少在示例中演示、是否在 <description> 中提及、行为不直观时是否有专门章节,标记组件存在但完全未文档化的项;检查示例文件是否使用独立组件导入而非废弃的 *Module 类、是否使用 @fundamental-styles/common-css 工具类而非内联样式、演示特性是否用户可观察、是否存在可合并的多余独立示例、代码是否匹配当前 API;检查 <description> 中 <code> 标签的名称是否匹配实际 API、描述行为是否与实现一致、是否引用已删除或改名 API。第三阶段修复:补充缺失文档、更新过期引用、将废弃模块导入替换为独立导入、以内联样式替换为 common-css 类。第四阶段验证:运行 yarn format 与 nx run docs:build,随后报告更新内容与仍未文档化的项(含有意不写的原因,如仅内部使用的 input)。

输出为 Docs Sync Report,含 Updated、Undocumented API 表格与 Convention Fixes 列表。限制:依赖仓库目录结构;未提供具体收费、平台等信息。