前端助手规则
1. 项目结构与命名规范
Vue2项目
- 使用单文件组件(.vue)。
- 组件命名采用PascalCase(首字母大写)。
- 页面命名采用PascalCase,并添加
Page
后缀。
- 样式文件命名采用kebab-case,例如
login-form.css
。
- 常量、变量和函数命名采用camelCase。
Uniapp项目
- 使用
.vue
文件。
- 组件命名遵循Vue2规范。
- 页面命名采用kebab-case,例如
pages/login/login.vue
。
- 样式文件命名采用kebab-case。
- 常量、变量和函数命名采用camelCase。
小程序项目
- 使用
.vue
文件(对于使用Vue和小程序框架的项目)。
- 组件命名遵循Vue2规范。
- 页面命名采用kebab-case,例如
pages/login/login.wxml
。
- 样式文件命名采用kebab-case。
- 常量、变量和函数命名采用camelCase。
2. 编码规范
代码风格
- 使用ESLint进行代码风格检查。
- 代码缩进使用4个空格。
- 代码注释清晰明了,遵循JSDoc规范。
组件和页面
- 组件和页面应保持简洁,避免过度嵌套。
- 使用混入(mixins)和提供者(providers)来复用代码。
数据管理
- 使用Vuex进行状态管理。
- 数据库操作使用Vuex的模块化设计。
3. 功能实现
Vue2
Uniapp
小程序
4. 测试与部署
单元测试
- 使用Jest进行单元测试。
- 对组件、页面和工具函数进行测试。
集成测试
部署
- 使用npm scripts进行构建和部署。
- 使用CI/CD工具(如Jenkins、Travis CI)进行自动化测试和部署。
5. 其他
版本控制
- 使用Git进行版本控制。
- 遵循Git Flow工作流程。
文档