SuperAPI AI 工具集

typescript

编程与开发

查看项目

更新于 10-15 21:50

技能介绍

用途:为 TypeScript 项目提供编码约定与模式,帮助写出整洁、可维护的代码。

主要能力与约定:

  • 通用原则:启用严格模式(tsconfig.json 中 "strict": true);优先 const 而非 let,禁用 var;导出的函数写出显式返回类型;对象形状优先用 interface 而非 type 别名;尽量用 unknown 代替 any。
  • 命名:变量与函数用 camelCase,类与接口用 PascalCase,真正常量用 UPPER_SNAKE_CASE,派生值用 camelCase,文件名为 kebab-case.ts,类型参数用单个大写字母(T、K、V)或描述性名称(如 TResult)。
  • 文件结构:src/ 下包含 index.ts(入口与导出)、types.ts(共享类型定义)、utils/(工具函数)、services/(业务逻辑)、middleware/(框架中间件)。
  • 错误处理:使用有类型的错误(继承 Error 类),始终处理 promise 拒绝,优先针对具体错误类型 try/catch。文中给出 AppError 示例,带 message、code 和默认 500 的 statusCode。
  • 异步模式:优先 async/await 而非裸 promise;独立并发操作使用 Promise.all();避免回调与 promise 混用。
  • 导入:使用命名导入,先外部包再内部模块分组,ESM 兼容时导入路径带 .js 扩展名。
  • 代码风格:最大行长 100 字符;字符串插值用模板字面量;转换优先 Array.map/filter/reduce 而非 for 循环;使用可选链 ?. 与空值合并 ??;访问多个属性时解构对象与数组。
  • 测试:测试文件与源文件同目录并列(thing.ts → thing.test.ts);用描述性测试名,如 it('should return empty array when no items match');覆盖空输入、null 值、错误条件等边界情况。

限制:资料未提供安装命令、收费方式、运行平台与具体使用步骤。