SuperAPI AI 工具集

source-command-refactor

编程与开发

查看项目

更新于 10-16 07:12

技能介绍

source-command-refactor 是一个用于深度代码库改进的重构技能,来源于 sylphxai/flow。当用户要求运行迁移后的 source command refactor 时,可以使用该技能。

用途 该技能旨在系统性地重构代码库,以最大程度提升代码质量。它覆盖代码清理、结构优化和类型强化等多个方面,适合在需要全面改善现有代码库质量时使用。

主要能力 技能针对以下目标进行重构:

  • 死代码:移除所有未使用的代码、导入、变量和函数。
  • 重复:提取共享逻辑,消除复制粘贴。
  • TODO:解决或移除每一个 TODO 注释。
  • 模块化:拆分大型文件,提取可复用模块。
  • 命名:重命名不清晰的变量、函数和文件。
  • 类型:强化类型,移除 any,补充缺失的类型。
  • 结构:将文件重新组织到逻辑文件夹中。
  • 依赖:移除未使用的依赖,更新过时的依赖。

使用方式 技能按照三个阶段执行:

阶段 1:扫描

  • 查找死代码:未使用的导出、不可达代码。
  • 查找重复:相似的代码块、复制粘贴模式。
  • 查找 TODO:使用命令 grep -r "TODO" --include=".ts" --include=".tsx"。
  • 查找大文件:超过 300 行的文件。
  • 查找弱类型:any、缺失返回类型。

阶段 2:重构 对于发现的每个问题:

  • 规划重构。
  • 进行修改。
  • 运行测试以验证没有回归。
  • 原子提交:refactor: description。
  • 立即推送。

阶段 3:验证

  • 运行完整测试套件。
  • 运行类型检查。
  • 运行 linter。
  • 验证构建成功。

规则

  • 每次提交一个逻辑变更。
  • 每次重构后测试必须通过。
  • 不改变行为——仅重构。
  • 如果需要改变行为,单独提交。

退出条件

  • 零 TODO。
  • 零死代码。
  • 零重复。
  • 所有测试通过。
  • 所有类型严格。

适用场景 适用于需要对代码库进行深度清理和结构优化的场景,特别是当代码中存在大量死代码、重复逻辑、未处理的 TODO、弱类型或混乱的文件结构时。也适合在迁移后需要运行 source command refactor 命令时使用。

限制 该技能的具体平台支持、收费模式、价格、效果保证等信息暂未提供。使用前需确保项目具备测试套件、类型检查和 linter,以便执行验证阶段。技能要求不改变行为,因此行为变更需另行处理。