SuperAPI AI 工具集

cmd-code-cleanup

智能体与模型

查看项目

更新于 10-16 02:37

技能介绍

用途:面向代码质量改进的清理技能,按顺序执行五个阶段,避免破坏可运行代码。

主要能力:阶段一移除死代码,包括未使用导入、无引用函数与类、未使用异常类、注释掉的旧代码;删除前用 grep 全库搜索(含主代码、scripts/、tests/、examples/ 及配置文件),并检查字符串引用、动态导入与 API 端点。阶段二消除重复,同一模式出现 3 次以上才提取辅助函数,2 次则保留。阶段三简化,移除仅有一种实现的工厂、无逻辑的配置包装、单次使用的工具类与透传函数,但保留定义清晰接口的基类。阶段四规范注释与 TODO,统一为 # TODO: description,删除显而易见的注释,保留解释“为什么”的注释与全部 docstring。阶段五最终审查,运行测试、检查导入并输出统计(删除行数、删除的函数与类、提取的辅助函数、规范化的 TODO)。

使用方式:调用该命令后先建立包含五个阶段的 TodoList,逐阶段执行并标记完成;批量改动前展示发现示例,删除整个文件、移除公共 API 或改动核心抽象前需征求确认。验证命令示例:grep -r "function_name" . --include="*.py"。

适用场景:清理遗留代码库、降低重复度、简化过度抽象,同时保留类型提示、良好 docstring、前瞻性基类与领域特定模式。

限制:不修改可用的抽象、类型提示、测试代码(除非明确损坏);不追求完美,强调务实改进;测试是否存在、具体统计结果等取决于项目实际情况,资料未提供更多细节。