SuperAPI AI 工具集

typescript-best-practices

编程与开发

查看项目

更新于 10-16 05:45

技能介绍

用途:为编写、审查或重构 TypeScript 代码提供默认编码规范,覆盖类型设计与常见模式。若仓库已有既定风格,应优先遵循仓库约定。

主要能力:类型优先设计,先定义类型再实现;对象结构用 interface,联合/映射/条件类型用 type;用 namespace 组织纯类型;用 <const TConfig> 获得严格字面量推断;从既有定义提取类型而非重复定义;采用最严格 tsconfig 基础配置并安装 ts-reset。

约定要点:命名上接口/类型用 PascalCase,泛型参数加 T 前缀(如 TUser、TConfig),缩写仅首字母大写(userId、ApiResponse),常量用 UPPER_SNAKE,变量/函数用 camelCase。数组用 Array<TItem> 与 ReadonlyArray<TItem>。空对象用 Record<string, never>,非原始类型用 object。避免 as 与 ! 断言,改用 Zod/arktype 运行时校验、satisfies 编译期检查、类型守卫与显式 null 检查。函数声明把类型写在 const 上,或用 satisfies 匹配既有组件类型。

使用方式:作为技能加载后,在编写、审查、重构 TypeScript 时按上述清单核对。提交前检查是否使用 interface/type 得当、无 as 或 ! 断言、品牌类型用 Zod .brand() 或 type-fest Tagged、命名符合约定、类型尽量从既有定义提取、复杂泛型有类型测试。

参考文件:type-patterns.md、code-style.md、union-exhaustive.md、branded-types.md、template-literals.md、type-testing.md、setup.md。

限制:这些规范是默认值,不替代项目特定约定;外部数据建议做运行时校验;避免过度设计类型。具体安装命令与配置细节暂未提供。