SuperAPI AI 工具集

cleanup-slop

通用与其它

查看项目

更新于 10-16 04:57

技能介绍

用途:cleanup-slop 只编辑注释,不触碰任何代码逻辑。判断标准是:有用注释应告诉读者无法从代码本身获得的信息,其余视为噪声。

主要能力:识别并删除高置信度的注释冗余,包括复述代码的注释、描述编辑动作的叙述、无 TODO 的桩标记、AI 套话、空 docstring 等;生成评估报告,指出需人工复核的中等问题(如超过 6 个月的陈旧 TODO、内部函数的通用 JSDoc)。始终保留引用 issue/PR/工单编号的注释、说明变通原因、不变量和加载性约束的注释、许可证头、类型系统编译指示(如 // @ts-expect-error、# type: ignore、// eslint-disable-next-line),以及公共 API 上的 JSDoc/TSDoc。

使用方式:先做预检——检测语言、Git 状态(工作区不干净则拒绝)、确保报告目录存在,并确认无需改代码;随后用 grep 和启发式规则定位问题;在 .claude/cleanup-reports/cleanup-slop-{YYYY-MM-DD}.md 写入评估报告;只自动删除高置信度项,且用 Edit 逐行删除;完成后以单次提交 chore(cleanup): cleanup-slop — removed N unhelpful comments 提交;最后运行 lint 或文档构建做验证,失败则回滚该文件。

适用场景:AI 辅助生成且未仔细审查的代码库、注释噪声较多的项目,适合作为代码整洁度维护的一步。

限制:该技能只删除、不重写注释;若“修复注释”需要改代码,应升级给用户;不得删除测试文件中解释测试意图的注释,也不得删除字符串或模板中看似注释的内容。关于安装方式,资料中暂未提供。