SuperAPI AI 工具集

fix-package-docs

编程与开发

查看项目

更新于 10-15 21:37

技能介绍

用途:系统性地查找并修复 Kibana 插件或包中所有可处理的 API 文档问题,适用于被要求修复、改进或补充 JSDoc/API 文档的场景。

主要能力:通过 check_package_docs 脚本生成结构化问题统计,覆盖 missingComments、missingReturns、paramDocMismatches、missingComplexTypeInfo、isAnyType、noReferences、missingExports、unnamedExports 等类别,并按文件分组逐项修复。

必要用法:先确定目标,插件 ID 用 --plugin <id>,清单 ID 或包名用 --package <id>,文件路径需先找到最近的 kibana.jsonc 所属包。生成统计:node scripts/check_package_docs.js --plugin <pluginId> --write(或 --package <manifestId> --write),结果写入 <pluginDir>/target/api_docs/stats.json,存在问题时退出码为 1 属正常。修复后验证:node scripts/check_package_docs.js --plugin <pluginId>,再运行 node scripts/check_changes.ts。

约定:仅对导出的公共 API 添加 JSDoc;只改文档,不改逻辑、类型或签名;使用 /** ... */ 风格;描述为完整句子;@param 用连字符分隔并覆盖全部参数;解构对象参数用点号标签逐层记录;非 void 函数需 @returns;跨类型引用用 {@link OtherType}。

限制:missingExports 与 unnamedExports 需人工判断,跳过并在 PR 中标注;noReferences 仅供参考、无需处理;isAnyType 仅在能确定正确类型时替换,否则用 unknown 或跳过。资料未提供该技能的收费、平台与效果信息。