SuperAPI AI 工具集

typescript-refactor

编程与开发

查看项目

更新于 10-14 05:41

技能介绍

用途

TypeScript Refactor 是一套用于指导 TypeScript 与 React/TSX 代码重构和现代化的最佳实践规则集,专为 AI 智能体与 LLM 设计。它包含 47 条规则,分布在 9 个类别中,按影响程度排序,用于支持自动化重构、代码审查和代码生成。内容更新至 TypeScript 6.0 与 React 19。

该技能适用于以下场景:重构 TypeScript 或 React/TSX 代码以提升类型安全性与可维护性;设计类型架构(判别联合、品牌类型、泛型);收窄类型以消除不安全的 as 强制转换;在 .tsx 文件中为 React 组件与 Hook 标注类型(props、refs、事件、state);采用现代 TypeScript 5.x–6.0 特性(satisfies、using、const 类型参数、推断类型谓词、可擦除语法、import attributes);优化大型代码库的编译器性能(isolatedDeclarations、项目引用);实现类型安全的错误处理模式;审查代码中的 TypeScript 陷阱与怪癖。

主要能力:规则类别

规则按优先级排列,每个类别有对应前缀:

  1. Type Architecture(CRITICAL,前缀 arch-):包括使用判别联合替代字符串枚举以实现穷尽匹配、用品牌类型防止领域标识符混淆、用 satisfies 保留字面量类型、用接口继承替代类型交叉以获得更好的错误信息、用 as const 获得不可变字面量推断、默认使用 readonly、避免滥用 Partial<T>。
  2. Type Narrowing & Guards(CRITICAL,前缀 narrow-):包括用运行时检查守卫替代 as(TS 5.5+ 可推断谓词)、用断言函数做前置条件检查、用 never 强制穷尽 switch、用 in 运算符收窄接口联合、通过收窄链消除 as 转换。
  3. Modern TypeScript(HIGH,前缀 modern-):包括用 using 关键字进行资源清理、用 const 类型参数做字面量推断、用模板字面量类型处理字符串模式、用 NoInfer 控制类型参数推断、启用 verbatimModuleSyntax、优先使用可擦除语法、用 with import attributes 替代已废弃的 assert。
  4. React & TSX(HIGH,前缀 tsx-):包括直接标注 props 而非使用 React.FC、在 React 19 中通过 prop 传递 ref 而非 forwardRef、用 ComponentPropsWithRef 扩展原生元素 props、用判别联合建模互斥 props、用 React 合成事件类型标注事件处理器、为可空与可变状态标注 useState/useRef。
  5. Generic Patterns(HIGH,前缀 generic-):包括最小化约束泛型、控制分布式条件类型、为重复转换构建自定义映射类型、在泛型函数中保留返回类型推断。
  6. Compiler Performance(MEDIUM-HIGH,前缀 compile-):包括为导出函数添加显式返回类型、避免深度递归类型定义、为 monorepo 构建使用项目引用、用基础类型替代大型联合类型、启用 isolatedDeclarations 以并行生成声明。
  7. Error Safety(MEDIUM,前缀 error-):包括用 Result 类型替代抛出异常、对类型化错误变体做穷尽检查、将 catch 变量标注为 unknown、将领域错误建模为判别联合。
  8. Runtime Patterns(MEDIUM,前缀 perf-):包括用联合字面量替代枚举(枚举不可擦除)、避免对对象使用 delete 运算符、用 Object.freeze 配合 as const 实现真正不可变、避免 Object.keys 类型放宽、对动态集合使用 Map 与 Set 替代普通对象。
  9. Quirks & Pitfalls(LOW-MEDIUM,前缀 quirk-):包括理解对象字面量的多余属性检查、避免 {} 类型(其含义为非空)、防范结构化类型逃逸口、使用变型注解记录泛型意图(而非为了速度)。

使用方式

各项规则配有独立的参考文件,包含详细说明与代码示例。参考文件包括:references/_sections.md(类别定义与排序)、assets/templates/_template.md(新增规则模板)、metadata.json(版本与参考信息)。

适用场景

适用于自动化重构、代码审查、代码生成等需要 TypeScript 类型安全指导的智能体任务,尤其是涉及类型架构设计、React/TSX 类型标注和大型代码库编译性能优化的场景。

限制

资料未提供该技能的具体安装命令、运行方式、收费模式、价格或平台支持信息,暂未提供。