Skip to content

/code-standards

编码规范守卫。任何代码生成请求时自动参考。

编码规范

生成代码前强制检查以下规则:

TypeScript

  • 所有函数必须有完整类型注解,禁止 any
  • 使用 named export,禁止 default export
  • 优先使用 interface 定义对象类型,type 用于联合/交叉类型

API Route

  • 所有输入用 zod schema 校验
  • 统一响应格式:{ data, error, meta }
  • 错误使用 AppError 类,不裸 throw Error
  • 如项目已采用 apiHandler 包装器,新增路由使用声明式写法(permission + audit + handler),不手写 try/catch 样板

React 组件

  • 函数式组件 + hooks,Props 定义为独立 type
  • 状态管理优先级:useState → useReducer → Zustand → Server State
  • 列表渲染必须有稳定的 key

文件结构

  • 单文件不超过 300 行,超出则拆分
  • 文件命名 kebab-case,组件 PascalCase
  • 新增代码优先参考项目中已有的同类实现

IMPORTANT:这些规则在任何代码生成时自动参考,不需要用户手动调用。

面向个人开发者的 AI 辅助编程工程化方案