SuperAPI AI 工具集

clean-code-guard

通用与其它

查看项目

更新于 10-16 02:28

技能介绍

用途:在代码交付前对生成、编辑或重构的生产代码做质量守卫,尤其针对 AI 生成代码的系统性失败模式。无需 MCP 服务器、网络、API 密钥或脚本,可在支持 SKILL.md 的任意运行时使用。

主要能力:提供三种模式。守卫模式在代码生成或修改后检查 diff 并修复违规;实时模式在用户显式调用后边写边应用规则,交付前自检;审查模式按 references/review-checklist.md 生成结构化发现报告,除非要求否则不改代码。规则来自 references/ 下多个文件,涵盖命名与函数、注释与格式、SOLID、DRY/KISS/YAGNI、AI 失败模式、审查清单与来源。

核心规则:函数 ≤20 行、参数 ≤4、圈复杂度 ≤10、嵌套 ≤5;名称揭示意图;注释解释 why;遵循文件既有风格;一模块一职责;不多做投机性设计;禁止宽泛吞错、硬编码成功返回或在生产代码中使用夹具;在信任边界验证,边界内信任契约;核实每个导入与外部调用;重构须保持可观察行为。

使用与限制:交付前按 24 条命令自检,并以“clean-code-guard: <N> fixed, <M> flagged for author”或“clean-code-guard: clean”报告。它不运行 linter、静态分析或测试,不替代项目格式化与类型检查,也不强制语言特定偏好;与项目约定冲突时遵循项目约定。概念性、CI、git 流程、散文、数据分析等任务不适用。若无法实现应以显式未实现错误失败,不得削弱测试。参考资料未提供价格或平台信息。