SuperAPI AI 工具集

clean-code

通用与其它

查看项目

更新于 10-15 17:18

技能介绍

用途:对当前分支的 diff 做代码质量审计与清理,只关注质量,不查正确性 bug、安全问题或性能问题。它是 Claude Code 内置 /simplify 的树内对应物,可在任意会话或流水线中调用(/qa-full 第 3 步会运行它)。

主要能力:按 KISS、DRY、SOLID、YAGNI 原则扫描改动文件,识别重复逻辑、一个单元承担多个变更原因、单一实现的抽象、无人读取的配置、死代码等信号,并给出 file:line 证据与最小修复方案。原则定义在安装目录的 ENGINEERING_STANDARDS.md 中,审计前需先阅读其 DRY、SOLID、YAGNI 章节。

使用方式:先确定 base ref(gh repo view 默认分支 → origin/HEAD → main/master),用 git diff --name-only <diff-ref>...HEAD 列出改动文件,跳过锁文件、生成代码、第三方目录和纯文档;找到并运行一次测试命令,若测试为红则停止。审计为只读发现,按 HIGH/MEDIUM/LOW 记录。修复时先补特征测试,再做最小安全重构,跑测试,绿则原子提交(提交信息注明原则与发现,如 clean-code: DRY — extract parseRange()),红则用 git checkout -- <files> 回滚该次修复涉及的文件。最后重新审计并跑全量测试,输出修复、未修复、警告和范围外事项报告。

限制:仅限 diff 范围,重构未改动模块本身违反 YAGNI;修复前工作树必须干净,禁止用 git stash 回滚;行为保持不变;一次审计、一轮修复、一次验证;不推送、不开 PR、不强制操作。若代码无测试,需先写特征测试再重构。

适用场景:分支提交前的质量清理、/qa-full 流水线中的质量环节,以及需要跨工具统一执行代码质量标准的团队。

暂未提供:具体安装命令、支持的平台清单与收费信息。