SuperAPI AI 工具集

ai-code-cleanup

编程与开发

查看项目

更新于 10-13 16:31

技能介绍

用途

AI Code Cleanup 用于清除分支中由 AI 生成的低质量代码痕迹。它适合在 AI 辅助编码会话结束后使用,也可在代码审查或合并分支前、清理“过度工程化”代码时、移除不必要的防御代码时、统一 AI 生成后的代码风格时,以及为生产环境准备代码时使用。

主要能力

该技能可识别 AI 生成代码的典型模式,并据此清理:

  • 识别 AI 痕迹:检测 AI 生成代码的常见特征。
  • 移除冗余:删除不必要的防御代码和注释。
  • 修复类型问题:移除不必要的类型转换和临时绕过写法。
  • 统一风格:确保与项目约定一致。
  • 保持功能:在提升质量的同时维持代码行为。
  • 验证变更:确保代码仍可编译且测试通过。

需要移除的“AI 痕迹”模式包括:

  1. 不必要的注释:解释显而易见代码的注释、与文件文档风格不一致的注释、复述代码的冗余注释、对简单操作的过度文档化。
  2. 防御性冗余:该代码库中不常见的额外 try/catch、对可信路径的防御性 null/undefined 检查、调用方已校验时的冗余输入校验、永远不会触发的错误处理。
  3. 类型绕过:用 any 绕过类型问题、不必要的类型断言(as X)、无正当理由的 @ts-ignore 或 @ts-expect-error、过于复杂的泛型约束。
  4. 风格不一致:命名约定与文件其余部分不同、格式与周边代码不符、导入组织与文件模式不一致、变量声明与文件风格不一致。
  5. AI 特征:代码或注释中不必要的 emoji、过于冗长的变量名、多余的中间变量、没有实际用途的“以防万一”代码。

使用方式

可直接以自然语言指令调用,例如:

  • 清理分支:“Remove AI slop from this branch”“Clean up the code in this pull request”
  • 定向清理:“Remove unnecessary comments and defensive code from src/”

清理流程:

  1. 获取差异:git diff $(git merge-base HEAD main)..HEAD --name-only
  2. 逐文件分析:读取完整文件以理解既有风格,识别上述冗余模式,做精准编辑并保持功能。
  3. 验证:确保代码仍可编译/运行,变更应减少而非增加代码,运行测试验证行为,检查是否有回归。

适用场景

  • AI 编码后的清理
  • 代码审查准备
  • 代码质量改进
  • 风格标准化
  • 移除技术债务

最佳实践

清理准则:只删除不影响行为的代码;遵循现有项目约定;保留真实错误处理;改动后务必验证代码仍可工作;增量修改、边改边测。

应保留:合理的错误处理、必要的类型断言、能补充上下文的有用注释、针对不可信输入的防御代码、与代码库一致的风格。

应移除:显而易见的注释、不必要的防御代码、类型绕过、风格不一致、AI 生成的痕迹。

参考文件

  • references/REFACTORING_PLAN.template.md:重构计划模板,包含代码异味、前后指标和回滚策略。

限制

关于支持的编程语言范围、安装方式、收费情况等,资料中暂未提供。