SuperAPI AI 工具集

clean-code-reviewer

测试与质量

查看项目

更新于 10-15 18:31

技能介绍

用途:对代码进行整洁度审查,依据《代码整洁之道》原则识别可维护性与可读性问题,并生成按严重程度排序的报告。审查仅针对实现方式优化,不改变代码功能、输出或行为。

主要能力:覆盖7个维度——命名(无意义命名、同一概念多种命名)、函数(超100行、参数超3个、做多件事)、重复(DRY,相似if-else、转换或错误处理逻辑)、过度设计(YAGNI,无用分支、单一实现接口)、魔法数字(裸露数字、硬编码字符串)、结构清晰度(嵌套三元、过深嵌套、过度紧凑单行)、项目规范(import顺序、声明风格、命名风格一致性)。严重程度分高(影响可维护性/可读性,应立即修复)、中(有改进空间)、低(代码气味,可选优化)。

使用方式:按工作流先扫描代码库识别待审查文件,逐维度检查,评定严重程度,再输出报告。报告格式为问题类型、原则、位置(文件:行号)、级别、问题、建议。支持通过参数限定范围或维度,如 /clean-code-reviewer --scope=components 或 --dimension=naming。可拆分给多agent并行:按维度、模块目录、语言或文件类型;汇总时需去重并统一严重程度。项目规范应参照 CLAUDE.md、AGENTS.md 或项目约定标准。

适用场景:TypeScript/JavaScript、Python、Go 等代码库的整洁度审查与改进建议,参考文件 references/detailed-examples.md 与 references/language-patterns.md。

限制:仅提供实现方式优化建议,不改功能;具体支持范围、版本、收费或价格暂未提供。