SuperAPI AI 工具集

code-cleanup

编程与开发

查看项目

更新于 10-15 10:10

技能介绍

用途

code-cleanup 是一个面向代码清理的提示词技能,目标是审查当前分支上的变更,并通过移除代码膨胀、重复内容和改进清晰度来将代码“产品化”(productionize)。

主要能力

  • 判断当前分支与基础分支,范围限定在分支差异内的变更文件。
  • 从代码膨胀、重复、注释、代码清晰度四个维度分析变更:识别冗余计算值、死代码、过大的函数、不必要的抽象;发现重复逻辑、相似条件分支、复制粘贴的代码块;清理重复注释、只解释“做什么”而非“为什么”的注释、多余的 JSDoc、过时注释;简化复杂条件、改进命名、提取魔法数字/字符串、减少深层嵌套。
  • 将问题分为 Critical(提交前必须修复)、Important(应当修复)、Minor(可选优化)三类。
  • 制定执行计划:先做低风险快速清理,再批量分组重构,并在关键点安排验证。
  • 应用变更后运行格式、类型检查、Lint、测试进行验证,最后提交。

使用方式

该提示词要求先满足工具前提:必须可用 Git CLI 以确定当前分支与基础分支;工作区应干净或仅包含预期变更。

工作流程包括:

  • Phase 0 确定范围:通过 git 命令识别当前分支与基础分支(latest 或最近的发布分支 bX.Y.Z),获取变更文件列表与完整 diff,并检查工作树状态。若存在未提交更改,会询问用户是暂存后仅处理已提交变更、将未提交变更一并纳入,还是先让用户自行提交后停止。
  • Phase 1 分析:逐文件分析代码膨胀、重复、注释与清晰度问题。
  • Phase 2 分类:按 Critical、Important、Minor 分组。
  • Phase 3 计划:优先快速清理、批量重构、设定验证点。
  • Phase 4 应用:逐项修改,运行 yarn nx format 保证格式一致,并验证无回归(类型检查、lint、测试如受影响)。
  • Phase 5 验证:yarn nx build:types <affected-packages>、yarn nx lint <affected-packages>、yarn nx test <affected-packages>(如测试文件或核心逻辑被修改)、yarn nx format。
  • Phase 6 提交:若产生变更,暂存所有更改并提交,提交信息为 chore: distil code quality improvements,并在提交正文中列出关键变更。

用户可提供 help 命令选项,此时提示词会解释如何使用该提示词、说明是否缺少前置条件或工具要求,并立即退出、不继续执行。

适用场景

适用于对当前分支的代码变更进行清理与产品化,尤其适合提交前审查、重构整理、减少代码冗余、提升可读性的场景。该技能针对特定项目上下文设计:项目为 Nx monorepo,包含多个包;发布分支命名为 bX.Y.Z 并遵循语义化版本;主分支为 latest;代码质量标准记录在 .rulesync/rules/code-quality.md。

关键原则与限制

  • 保持功能不变:除非修复 bug,否则不改变行为。
  • 采用小而增量的变更,便于审查与验证。
  • 不随意移除有测试覆盖的代码,需先理解原因。
  • 保留解释性能权衡的注释。
  • 提倡自文档化代码,通过良好命名减少注释需求。
  • 依赖 Git CLI;工作区需干净或仅含预期变更。
  • 具体命令与路径需在满足该 Nx monorepo 项目上下文时使用。

暂未提供:安装方式、收费/价格、平台支持、效果度量或耗时等具体信息。