64 lines
2.5 KiB
Plaintext
64 lines
2.5 KiB
Plaintext
---
|
||
globs: *.vue
|
||
alwaysApply: false
|
||
---
|
||
|
||
# Vue 开发规范
|
||
|
||
- 你是一位前端开发专家，精通 Uniapp、Vue、Pinia、Uview Plus 等前端框架
|
||
|
||
## 代码风格
|
||
|
||
- 组件: 使用单文件组件 (SFC)
|
||
- API: 使用组合式 API (Composition API) 并搭配 `<script setup>` 语法糖
|
||
- 语法: 没有特殊说明则使用 TS 进行开发 `<script setup lang="ts">`
|
||
|
||
## 命名
|
||
|
||
- 组件 (Component) 命名: 始终采用单词大写开头 (PascalCase) 的命名方式, 并且避免与 HTML 元素冲突
|
||
- 组件 (Component) 命名示例: 以全局的 `lang-select` 组件 `@/components/lang-select/index.vue` 和 `@/components/agree-privacy/index.vue` 作为参考，注意 `index` 是不需要遵循大驼峰格式的
|
||
- 页面 (Page) 命名: 始终采用短横线连接 (kebab-case) 的命名方式
|
||
- 页面 (Page) 命名示例: 以 `home` 页面作为参考 `@/pages/tab/home/index.vue`
|
||
- 组合式函数 (Composable) 命名: 始终采用小驼峰 (camelCase) 的命名方式
|
||
- 组合式函数 (Composable) 命名示例: 以剪贴板组合式函数作为参考 `@/hooks/use-clipboard/index.ts`
|
||
- Props 命名: 在声明 prop 的时候，其命名应该始终采用小驼峰 (camelCase)，而在模板应该始终采用短横线连接 (kebab-case)
|
||
- Props 命名示例: 声明时 `const { isActive = false } = defineProps<Props>()` 和传递时 `<Demo :is-active="true" />`
|
||
- TS 或 JS 文件命名: 始终采用短横线连接 (kebab-case) 的命名方式
|
||
- TS 或 JS 文件命名示例: `@/utils/index.ts`
|
||
|
||
## API
|
||
|
||
- 定义响应式变量时优先使用 `ref` 而非 `reactive`
|
||
- 复杂的模板表达式则应该重构为计算属性或方法
|
||
- 尽量避免侦听器的循坏触发，防止进入死循环
|
||
|
||
## Props
|
||
|
||
- Prop 定义应该尽量详细，包括类型、必传、默认值
|
||
- 如果是使用了 TS 那么应该使用「基于类型的声明」，示例: `const props = defineProps<Props>()`
|
||
|
||
## 状态管理
|
||
|
||
- 对应目录: `@/store`
|
||
- 使用 Pinia
|
||
- Store 应该按模块划分
|
||
- 优先使用 Setup store 语法，而不是 Option Store 语法
|
||
- 避免无脑使用全局状态管理
|
||
|
||
## 样式
|
||
|
||
- 优先使用 Scoped CSS，示例: `<style scoped lang="scss">`
|
||
- 尽可能避免使用 `!important`
|
||
- 优先使用 UnoCSS 内联样式
|
||
|
||
## 其他
|
||
|
||
- 避免直接操作 DOM
|
||
- 尽可能编写原子化组件
|
||
- 使用 `v-for` 时必须提供唯一的 `key` (不要轻易使用数组下标 `index` 当做 `key`)
|
||
- 不要在同一元素上同时使用 `v-if` 和 `v-for`
|
||
|
||
## 参考示例文件
|
||
|
||
@/pages/tab/home/index.vue
|