用途:该技能在 code-developer 或 quality-reviewer 处理 TypeScript 文件时被调用,用于提供统一的 TypeScript 编码规范,覆盖类型安全、命名、类型定义、函数签名、错误处理、导入、代码组织、文档、反模式、代码质量等方面。
主要能力:
- 类型安全:在 tsconfig.json 启用 strict 模式;避免 any,类型不确定时用 unknown;用 as const 做字面量类型;明显时优先类型推断;复杂状态建模用可辨识联合。
- 命名约定:类型、接口、类用 PascalCase;变量、函数、属性用 camelCase;常量用 UPPER_SNAKE_CASE;仅在避免冲突时给接口加 I 前缀;使用揭示意图的描述性名称。
- 类型定义:对象类型优先用接口(可扩展);联合、交叉和工具类型用类型别名;类型定义靠近使用处;库模块从 index 文件导出类型;使用 Partial、Pick、Omit、Record 等工具类型。
- 函数签名:公共函数始终指定返回类型;谨慎使用带默认值的可选参数;复杂签名优先用函数重载;可复用且类型安全的函数用泛型。
- 错误处理:用可辨识联合定义类型化错误;优先 Result<T, E> 模式而非抛异常;在 JSDoc 中记录抛出的异常;显式处理所有错误情况。
- 导入:用路径别名(@/ 前缀)简化导入;按外部、内部、相对分组;尽量用命名导入而非默认导入;避免循环依赖。
- 代码组织:每个文件一个组件/类(小型辅助除外);相关文件(组件、样式、测试)就近放置;用 index 文件做桶导出;文件尽量控制在 300 行以内。
- 文档:公共 API 用 JSDoc;记录复杂类型定义;解释不明显的类型断言;注释与代码变更保持同步。
- 反模式:避免无理由的类型断言(as Type)、无空值检查的非空断言(!)、继承其他类型的空接口、过度使用 Pick/Omit、魔法数字、修改函数参数。
- 代码质量:配置带 TypeScript 插件的 ESLint,启用推荐规则,用 Prettier 统一格式,提交前修复所有 lint 错误;对关键类型工具做类型测试,测试类型收窄逻辑,验证可辨识联合的穷尽性。
使用方式:当 code-developer 或 quality-reviewer 处理 TypeScript 文件时调用本技能,按上述规范编写或审查代码。
适用场景:TypeScript 项目的开发与代码质量审查。
限制:资料未提供具体安装命令、配置示例、收费或平台信息,暂未提供。