SuperAPI AI 工具集

typescript

编程与开发

查看项目

更新于 10-16 06:55

技能介绍

用途

该技能定义了一套 TypeScript 编码规范,用于在编写、审查或重构 .ts/.tsx 文件时统一代码风格,以及在命名或重命名 .ts 文件时确定文件名格式。它来自 forcedotcom/salesforcedx-vscode 仓库,属于团队内部的约定集合。

主要能力(规范条目)

  • 不使用 barrel 文件。
  • 异步不使用 void,改用 async/effect(例外:vscode-window-messages)。
  • 不使用 export *,导出需显式命名。
  • 优先使用 undefined 而非 null(除非服务端要求 null)。
  • 优先使用 undefined 而非空字符串。
  • 优先使用 map/filter 而非循环与条件判断。
  • 避免可变操作(avoid mutation)。
  • 避免 any。
  • 从真实来源派生类型,不要为了满足编译器而手写或收窄类型;例如使用 ReturnType<> 来匹配某物。
  • 不使用 enum 或 namespace(enum 会编译成奇怪的 JS;改用字符串联合类型;例外:本仓库之外无法修改的接口)。
  • 不为开发者失误引入运行时错误(使用类型确保 switch/case 穷尽;当输入/消费方在可控范围内时,不要为 null/undefined 抛错)。
  • .ts 文件名:camelCase,无连字符,无首字母大写。
  • 重构时保留注释;若注释错误或过时则删除或修正。
  • 导出函数:若名称不清晰,使用单行 JSDoc /*_ foo _/;不写参数/返回值(TypeScript 已提供类型)。
  • 查找使用 (Object|Map).groupBy 替代旧模式的地方。
  • 冗余的空集合守卫:如果 arr.find/some/every/map/filter/reduce 对空数组已返回相同值,则删除 if (arr.length === 0) return … 守卫。例如对 [] 调用 find 返回 undefined,因此守卫返回 undefined 是死代码。
  • 不必要的 const 声明:直接 return,而不是 const x = val; return x(例外:复杂表达式,使用 const 可提升可读性)。

使用方式

资料未提供具体安装命令、配置方式或调用步骤,暂未提供。

适用场景

适用于编写、审查或重构 .ts/.tsx 文件,以及命名或重命名 .ts 文件时。

限制

资料仅列出规范条目,未说明适用范围、版本要求、工具集成方式或例外情况的完整清单,暂未提供。