SuperAPI AI 工具集

typescript-best-practices

编程与开发

查看项目

更新于 10-16 01:35

技能介绍

用途:该技能提供 TypeScript 的类型优先开发模式,帮助在编译期消除非法状态、保证穷尽处理,并在系统边界做运行时校验。处理 React 组件(.tsx、.jsx 或 @react 导入)时,应同时加载 react-best-practices,本技能只覆盖 TypeScript 基础。

主要能力:类型优先工作流(先定义数据模型与函数签名,再实现以满足类型,最后在边界校验);用可辨识联合表示互斥状态、用品牌类型区分领域原始值、用 as const 生成字面量联合;区分创建/更新/数据库行的必填与可选字段;模块结构建议单文件单一职责、测试与实现同目录、按功能分组;函数式模式建议 const、readonly、map/filter/reduce 与纯函数。

使用方式:启用 strict 模式;每条代码路径返回值或抛错,switch 用 never 做穷尽检查;错误带上下文传播;显式处理空数组、null/undefined 与边界值;异步用 await 并包装外部调用;改逻辑时补充聚焦测试。运行时校验推荐 Zod:以 schema 为唯一来源并用 z.infer 推导类型,用户输入用 safeParse,信任边界用 parse,用 extend/pick/omit/merge 组合,用 transform 归一化,用 refine 自定义校验。配置从环境变量加载并在启动时用 Zod 校验,非法配置立即崩溃,避免散落访问 process.env。可选 type-fest 提供 Opaque、PartialDeep、ReadonlyDeep、LiteralUnion、SetRequired、Simplify 等工具类型。

限制:资料未提供安装命令、版本要求、收费方式与平台信息;示例代码仅作模式说明,需按项目实际情况调整。