Vue3 项目开发规范 (Vue3 Template Standard)
本 Skill 旨在指导开发者如何正确使用本项目中的封装组件和工具函数,确保代码风格统一且符合项目架构设计。
核心原则(重点)
- •优先复用:在开发新功能时,必须优先查看
src/components/ui和src/composables下是否已有封装好的组件或逻辑。 - •规范命名:所有 UI 组件以
c-开头(如c-table),Composable 以use开头。 - •数据驱动:表格和弹窗等交互应尽量通过配置项(JSON)驱动,而非指令式操作。
- •错误处理:网络请求必须使用
await-to-js风格的工具函数to处理。 - •工具函数:优先使用
src/utils下的工具函数,不要重复造轮子。 - •善用tailwindcss:优先使用
tailwindcss提供的工具类,不要重复造轮子。 - •主题色:在进行页面设计时,优先使用
src/assets/styles/theme.scss中定义的变量,不要直接使用颜色值,或者使用和当前主题色相近的颜色。 - •图标规范:优先使用
lucide-vue-next库中的图标,不要重复造轮子。
详细指导文档
开发者应详细阅读以下专项规范:
- •表格组件使用指南
- •搜索组件使用指南
- •表单组件使用指南
- •弹窗 Composable 使用指南
- •API 与网络请求规范
- •UI 系统配置
- •目录与文件命名规范
- •Vue 3 生态最佳实践
- •图标规范: 优先使用
lucide-vue-next库中的图标
使用建议
每次开始编写新页面或新 API 时,建议先运行 view_file 查看本 Skill 目录下的对应文档,以避免重复造轮子或破坏项目架构。