SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 05:53

技能介绍

用途:提供 TypeScript/JavaScript 的整洁代码与重构实践,用于识别代码异味、改进命名与结构、提升可维护性,适合代码质量审查或重构时参考。

主要能力:

  1. 代码异味识别:涵盖命名(单字母名、缩写、泛化名、误导名、类型编码)、函数(参数过多、标志参数、隐藏副作用、巨型函数、深层嵌套)、结构(文件过长、依恋情结、数据泥团、基本类型偏执、按类型分支)等类别。
  2. 重构模式:守卫子句、对象查找表替代 switch/if-else、选项对象、具名常量、提取函数、扁平化三元、合并重复、简化布尔、数组方法替代手写循环、解构。
  3. 命名约定:函数用动词+名词(createUser)、布尔用 is/has/can/should 前缀、事件处理用 handle+事件、转换用 to/from/parse/format;变量布尔用正向命名、数组用复数、计数用 noun+Count;模块级常量用 SCREAMING_SNAKE_CASE。
  4. 快速检查清单:命名意图、单一职责与行数、参数数量、嵌套层级、重复、魔法值、注释与死代码。
  5. 反模式:过度工程(单次使用仍抽象、预留配置、包装简单操作)、工程不足(重复 3 次以上不提取、深层嵌套、滥用 any)、错误抽象(强制继承、上帝类、拆散紧耦合逻辑)。

使用方式:作为编码与审查时的对照清单,逐项检查命名、函数、参数、嵌套、重复、魔法值与死代码;难度阈值可参考资料:函数超 20 行、参数超 3 个、嵌套超 3/2 层、文件超 300 行、重复 3 次以上即考虑重构。详细前后对照片段见 references/refactoring-patterns.md。

适用场景:TypeScript/JavaScript 项目代码评审、重构、编写新代码时保持整洁与可维护性。

限制:资料未提供具体安装命令、运行环境、平台支持、收费方式或与自动化工具集成的步骤,暂未提供相关信息。