用途:为团队项目提供统一的编码规范,减少风格分歧,提升代码可读性与可维护性。适用时机包括代码审查、新建文件、重构、确认编码风格和团队开发规则确认。
主要能力:
- TypeScript:要求显式类型定义,类型推断明确时可省略;禁止使用 any,改用 unknown 并配合类型守卫安全处理;使用可选链 ?. 和空值合并 ??,避免用 || 处理可能为空字符串的默认值。
- 导入顺序:外部库、内部模块(别名)、相对导入,依次排列。
- 命名规则:变量与函数 camelCase,常量 UPPER_SNAKE_CASE,类与类型 PascalCase,文件 kebab-case,React 组件 PascalCase,环境变量 UPPER_SNAKE_CASE;布尔值使用 is/has/can/should 前缀。
- 函数:遵循单一职责,拆分多职责函数;用早期返回减少嵌套。
- 错误处理:定义自定义错误类,按错误类型分支处理,未知错误记录日志并返回通用错误。
- 注释:解释 WHY 而非 WHAT;TODO/FIXME 需附带 issue 编号。
- React/Next.js:区分 Server Component 与 Client Component,仅在需要交互时使用 'use client';Props 显式定义类型。
- Git 提交:采用 Conventional Commits,前缀包括 feat、fix、docs、refactor、test、chore。
使用方式:作为项目编码规范文档,在开发、审查和重构时对照执行;文中示例为规范说明,不包含可直接运行的安装命令。
限制:资料未说明具体的自动检查工具、配置方式、适用语言范围或版本要求,暂未提供相关信息。