SuperAPI AI 工具集

typescript-best-practices

编程与开发

查看项目

更新于 10-15 22:13

技能介绍

用途:在编写或重构 TypeScript 的类、函数、模块或异步逻辑时,提供一套惯用写法规范,帮助产出整洁、可维护的代码。优先级标注为 P1(HIGH)。

主要能力与约定:命名上,类/类型/接口用 PascalCase,变量与函数用 camelCase,静态常量用 UPPER_SNAKE。函数方面,回调与逻辑用箭头函数,顶层导出用函数声明,公共 API 返回值必须标注类型。模块只使用具名导出,便于重构与自动导入。异步使用 async/await,并行用 Promise.all(),用 try-catch 处理错误,catch(e) 类型为 unknown 并在使用前收窄,避免 .then().catch() 链。类中显式使用 private、protected、public 修饰符,优先组合而非继承,采用构造函数注入与接口实现依赖注入,而非单例,以提升可测试性。类型安全上用 never 做 switch 的穷尽性检查;用可选链 ?. 与空值合并 ?? 替代手动判断。导入顺序通过 eslint-plugin-import 自动强制为外部包 → 内部模块 → 相对导入,接口/类型用 import type 以获得更好的 tree-shaking 与零运行时开销。运行时边界校验使用 Zod 或 Tsoa。

反模式:禁止默认导出、隐式返回、未使用变量(启用 noUnusedLocals)、require(改用 ES6 import)、空接口、any(改用 unknown 或具体类型)、不安全 mock(用 jest.Mocked<T> 或 as unknown as T)、eslint-disable(应修复根因而非抑制警告)。

参考:references/examples.md 中包含不可变接口、穷尽性检查、断言函数、DI 模式与导入组织。

限制:资料未提供安装命令、平台支持、收费方式或具体使用步骤,暂未提供。