SuperAPI AI 工具集

simplify

编程与开发

查看项目

更新于 10-23 08:27

技能介绍

用途

Simplify 是一个行为保持型代码简化技能,目标是在不改变代码行为的前提下,提升代码可读性、降低认知负担。其核心规则是:简化后代码必须做完全相同的事——不允许行为变更,不允许顺手做“改进”,不允许修改 API 表面。若简化后测试失败,则说明简化本身是错的,应回退。

该技能与删除已验证无引用代码的 remove-deadcode 技能相区分:前者用于简化代码,后者用于删除死代码。

主要能力

减少嵌套

  • 提前返回:将 if (x) { ...整个函数... } 替换为 if (!x) return,把 3 层以上嵌套展平为直线代码。
  • 守卫子句:在函数顶部检查前置条件并提前退出。
  • 仅在抽取能澄清意图时,才把深层嵌套块提取为命名良好的函数,而非条件反射式提取。

移除不必要的抽象

  • 单调用者函数:内联它,只被一个地方调用的函数只是间接开销。
  • 单实现接口:删除接口,直接使用具体类型。
  • 薄包装:若某函数只是用相同参数加一个默认值调用另一函数,需判断该包装是否值得保留。
  • 过度通用的工具函数:例如只以 createMapWithDefaultValue(x, {}, 'lru', 'none') 方式调用的 createMapWithDefaultValue(key, defaultVal, strategy, cachePolicy),应直接改为具体代码。

减少变量数量

  • 内联单次使用变量:变量恰好只被使用一次时,在使用处内联其值;这是收益最高的简化手段。
  • 消除临时“解释”变量:若变量名只是复述右侧表达式,即删除。
  • 反例:const isActive = user.status === 'active'; if (isActive) ...
  • 更佳:if (user.status === 'active') ...,条件本身已自解释。

简化条件表达式

  • 赋值场景用三元表达式替代 if/else:const x = cond ? a : b 优于 5 行 if/else。
  • 删除冗余 else:在 return/throw/break 之后的 else 是多余负担。
  • 返回布尔值时用布尔表达式:
    • 反例:if (x > 0) { return true; } return false;
    • 正例:return x > 0;

缩小公开面

  • 取消不必要导出:符号若仅在本模块内使用,就不要导出;更小的公共 API 意味着更少需要理解的内容。
  • 删除无用参数:函数接受但从不使用、且无调用者有意义传入的参数应删除。

使用方式

该技能以清单形式给出简化模式,每一条都附带“仅当能降低复杂度且不改变行为时才应用”的前提。典型使用流程如下:

  1. 运行现有测试,确认在动手前全部通过。
  2. 每次只做一处简化,绝不批量处理;一次编辑、验证、提交。
  3. 每次简化后运行测试;若有失败立即回退。
  4. 使用 LSP 的“查找所有引用”,在内联前确认函数确实只有一个调用者,在删除参数前确认参数确实未被使用。

完成简化后按固定格式报告:

## Simplified: <file>:<function or section>
- Before: <原复杂度模式,例如“4 层嵌套 if”>
- After: <改动内容,例如“提前返回,展平为 1 层”>
- Tests: <全部通过 / N 个测试未变化>

若检查代码后未发现有效简化点,应明确说明,而不是强行改动。

适用场景

  • 代码“过于聪明”:过度抽象、嵌套过深、难以跟随。
  • 功能落地后代码累积了冗余。
  • 评审反馈指出“这里难以理解”。
  • 发现不必要的间接层:不增加价值的包装、只有一个实现的接口、恰好只被调用一次的函数。

限制与禁止事项

  • 不得简化性能关键代码,其中“巧妙”是有意为之且有基准测试支撑。
  • 不得简化框架样板代码(路由定义、依赖注入注册、schema 声明),它们遵循框架约定而非逻辑。
  • 不得简化错误处理路径,绝不为了“简化”而删除错误检查。
  • 不得修改公共 API 签名,那属于破坏性变更而非简化。
  • 不得简化刻意用冗长 setup 覆盖边界条件的测试代码。