SuperAPI AI 工具集

clean-typescript

编程与开发

查看项目

更新于 10-15 09:51

技能介绍

Clean TypeScript 是一套面向 TypeScript 代码编写的实践规范,目标是在保证正确性的同时提升代码清晰度,减少不必要的类型仪式感。它强调 TypeScript 应作为正确性与清晰度的工具,而不是为了类型而类型;类型应当减少缺陷和认知负担。

类型哲学 优先选择显式、可读的类型,而不是炫技或过度泛化的类型。避免使用 any 和不安全的类型断言;在确实需要宽松类型时,使用 unknown 替代 any。当类型推断清晰且稳定时,让 TypeScript 自行推断。

类型与接口 在大多数使用场景中优先使用类型别名(type alias)。interface 主要用于公开的、可扩展的对象结构。类型应保持小巧、可组合且命名良好。

函数与 API 公开函数优先显式声明返回类型。除非能显著改善 API,否则避免使用函数重载。保持函数签名简单且可预测。

空值与安全 显式处理 null 和 undefined。除最后手段外,不要依赖非空断言(!)。优先通过控制流和类型守卫进行类型收窄。

枚举与常量 避免使用 enum。优先使用联合类型或 as const 对象。保持运行时输出可预测且最小化。

错误处理 显式标注错误和错误状态。在合适场景下,优先返回结果对象或类型化错误,而不是抛出异常。不要用宽泛的类型掩盖失败模式。

总体原则 类型应当解释意图。如果一个类型难以理解,它很可能是错误的。可维护性优先于理论上的完备性。

适用场景:该规范适用于定义或使用类型以及其他 TypeScript 特性的场景,可作为团队或个人编写 TypeScript 代码时的参考准则。

限制:资料未提供具体的安装命令、代码示例、平台支持范围、收费方式或效果数据,这些内容暂未提供。