SuperAPI AI 工具集

gap-detection

智能体与模型

查看项目

更新于 10-16 02:36

技能介绍

用途:Gap Detection 用于在会话启动或按需对代码库做结构化健康检查,帮助在陌生仓库中开始重要工作前或作为持续质量门禁,发现文档、测试与注释方面的缺口。

主要能力:扫描缺少 README/index.md 的源文件目录;查找没有对应测试文件的源文件;统计并定位 TODO/FIXME/HACK/XXX 标记;检测缺少 JSDoc 或行内注释的公开导出。最终汇总为健康报告,含各类别计数、按优先级排序的缺口清单和建议操作。

使用方式:按工作流依次执行资料中给出的 find、grep 命令,分别输出 NO_README、NO_TEST、TODO/FIXME、NO_DOC 结果,再编译报告并写入 .claude/context/tmp/gap-detection-report-{{date}}.md。执行前读取 .claude/context/memory/learnings.md,完成后追加摘要;发现严重缺口时追加到 issues.md。输入输出分别受 schemas/input.schema.json 与 schemas/output.schema.json 约束。

适用场景:新仓库会话启动、规划功能前了解质量债务、代码审查中识别未文档化新增内容、主动审计流水线。

限制与原则:没有证据不得报告健康结论,每条发现必须引用文件路径及适用时的行号;不得在未实际运行扫描命令时报告“无缺口”;不得忽略 TODO/FIXME;不得扫描 node_modules、dist、.git 目录。相关技能包括 proactive-audit、tdd、debugging、context-compressor;主要面向 developer、qa,architect 与 planner 为支持角色。