编码规范
TypeScript 规范
- 禁止使用
any,必须明确类型声明 - 优先使用
interface定义对象类型 - 使用
type定义联合类型、工具类型 - 函数返回值类型必须明确声明
Vue 组件规范
- 必须使用
<script setup lang="ts"> - 禁止使用 Options API
- Props/Emits 必须用 defineProps/defineEmits 声明类型
命名规范
| 类型 | 规范 | 示例 |
|---|---|---|
| 组件文件 | PascalCase | UserDialog.vue |
| 组合式函数 | use + PascalCase | useUserList.ts |
| 工具函数 | camelCase | formatDate.ts |
| Store 文件 | camelCase | user.ts |
| 路由路径 | kebab-case | /user-manage |
| 常量 | UPPER_SNAKE_CASE | API_BASE_URL |
样式规范
- 优先使用 Tailwind CSS 原子类
- 复杂样式使用 CSS 变量
- 禁止内联样式
- 组件样式必须使用
scoped