用途:这是一份 TypeScript 代码风格指南,用于在编写新代码、审查 .ts 文件、重构、生成代码片段或文档,以及处理 Markdown、Vue.js 等中的 TypeScript 代码块时统一格式。
主要规则:语句末尾不加分号,但接口、类型等类型定义中的属性分隔符必须使用分号;条件语句中不直接调用方法,需先提取为变量;类型化代码中检查值是否存在时使用显式比较(如 value === undefined、value !== null、value === ''),不依赖真值/假值收窄;函数调用不作为参数,需先提取为变量(验证器 schema、DSL 配置、查询构建器、匹配器 API 等少数场景可嵌套但需换行);单行 const/let 声明连续排列,单行与多行声明之间、多行声明之间加空行;局部命名避免不清晰的缩写(id、db、URL、HTML 等通用标识符可用);单行 JSDoc 注释写在同一行;对象键排序为简写属性在前、普通属性在后,各组内按字母排序;多键对象和多元素数组每项一行,单键对象和单元素数组可保持一行;对象中的多行值之间加空行;不使用尾随逗号;派生数据在 return 前先计算为独立变量,避免用展开运算符重建对象;多行块(if/else、循环、try/catch、函数等)与其他代码之间加空行,return 前同样加空行;接口和命名类型别名只保留一层命名属性,嵌套对象形状需提取为独立接口。
使用方式:在涉及 TypeScript 的编写、评审、重构和格式化场景中应用上述规则,完整代码示例见 references/examples.md。
限制:资料未提供安装命令、配置方式、平台支持、收费或效果信息。