SuperAPI AI 工具集

clean-typescript

编程与开发

查看项目

更新于 10-15 09:50

技能介绍

Clean TypeScript 是一份面向 TypeScript 开发的编码技能规范,目标是写出整洁、高效、符合常见最佳实践的 TypeScript 代码。

类型哲学 把 TypeScript 当作保证正确性与清晰度的工具,而不是为了形式而形式。类型应当减少 Bug、降低认知负担。在类型选择上,优先使用显式、可读的类型,而不是炫技式或过度泛化的类型;避免使用 any 和不安全的类型断言;在确实需要时用 unknown 替代 any;当类型推断清晰且稳定时,让 TypeScript 自行推断。

类型与接口 在多数场景下优先使用 type 别名;interface 主要用于公开、可扩展的对象形状。类型应保持小巧、可组合,并且命名良好。

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

可空性与安全性 显式处理 null 与 undefined;除非万不得已,不要依赖非空断言(!);优先通过控制流和类型守卫进行类型收窄。

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

错误处理 显式标注错误类型与错误状态;在合适的情况下,优先使用结果对象或类型化错误,而不是直接抛出;不要用宽泛类型掩盖失败模式。

总体原则 类型应当解释意图;如果一个类型难以理解,它很可能本身就是错的;在可维护性与理论完备性之间,优先选择可维护性。

适用场景与限制 该规范适用于使用 TypeScript 进行开发、并希望统一代码风格与类型策略的项目或团队。关于具体安装方式、命令、价格、平台支持等细节,资料中暂未提供。