typescript-style-guide

TypeScript 风格指南

仅应用与当前任务相关的约定。对于 TypeScript、代码检查工具和格式化工具能够自动强制执行的规则，应由它们负责。

工作流程

1. 检查使用该指南的仓库中的约定和配置。
2. 如仓库中有明确约定，应优先遵循，而非本指南中的主观建议。
3. 确定适用的指南主题。
4. 只阅读与任务主要主题对应的参考文档。只有当任务实质上涉及多个主题时，才阅读多个参考文档。
5. 根据当前任务应用、审查或说明相关约定。
6. 当约定取决于上下文或判断时，说明重要的权衡。

参考文档导航

• 类型建模、类型推断、只读数据、常量、模板字面量类型、any、unknown、类型断言、类型错误、类型定义、数组、类型导入和生成的服务类型，请阅读 references/types.md。对于收窄 unknown 和类型断言（包括运行时空值检查），本文档具有优先权。
• 一般的判别联合建模、收窄、无效状态、穷尽性检查、必需和可选对象属性、带有特定变体数据的应用状态、函数参数以及 React props，请阅读 references/discriminated-unions.md。当判别联合涉及应用状态、函数参数或 React props 时，本文档具有优先权。
• 函数职责、无状态性、纯度、副作用、函数参数、函数 API 设计和返回类型，请阅读 references/functions.md。
• 当任务涉及变量声明、简单字面量联合状态建模、枚举替代方案，或选择应用状态如何用 null 或 undefined 表示缺失时，请阅读 references/variables.md。对于偶然涉及的变量或仅用于类型收窄的运行时检查，请勿阅读该文档。
• 命名导出、命名约定、泛型类型参数、React 命名、注释和 TSDoc，请阅读 references/naming.md。
• 代码协同布局、按功能组织、相对和绝对导入路径，以及前端或后端项目结构，请阅读 references/source-organization.md。类型专属导入的语义属于 Types，请勿为此阅读该文档。
• React 组件和 Hook API、props 到 state 的转换、组件类型与职责、数据流、状态放置位置以及复合组件，请阅读 references/react.md。
• 测试设计、Arrange-Act-Assert 模式、隔离、实现细节、模拟、测试描述和快照，请阅读 references/tests.md。

适用范围

• 不要重新实现 TypeScript、ESLint 或格式化工具能够确定性执行的检查。
• 不要仅仅因为启用了本技能，就引入无关约定。
• 如果使用该指南的仓库没有明确规定，则将指南中的约定视为默认做法。