vben 项目开发规范
本规范文档参考 vben-admin 官方文档 及社区最佳实践，适用于基于 vben-admin 进行二次开发和团队协作的项目。
1. 项目结构规范
- 遵循 vben-admin 的 Monorepo 目录结构，核心目录包括：
apps/：应用层，前端主应用、mock 服务等packages/：业务包、工具包、类型、样式、图标等internal/：内部配置与工具scripts/：自动化脚本
- 前端主应用
src/目录结构建议：api/：接口封装views/：页面视图，按业务模块分子目录store/：状态管理router/：路由配置layouts/：页面布局locales/：多语言adapter/：适配器
2. 代码风格与开发规范
- 推荐使用 TypeScript 进行类型安全开发。
- 遵循 ESLint + Prettier 统一代码风格。
- 变量、函数、组件命名采用小驼峰（camelCase），类名采用大驼峰（PascalCase）。
- 组件文件建议使用
.vue单文件组件，目录结构清晰。 - 业务逻辑与视图分离，复杂逻辑抽离为 hooks/composables。
- 严格使用 Git 分支管理，建议采用
feature/xxx、fix/xxx、release/xxx等命名规范。
3. 组件开发与复用规范
- 组件开发遵循"高内聚、低耦合"原则，通用组件抽离至
@core/ui-kit或packages下统一管理。 - 组件 props、emit 事件需注明类型和用途，文档齐全。
- 复用性强的业务组件建议沉淀为独立包，便于多项目共享。
- 组件样式优先使用 CSS 变量、主题色，支持主题切换。
4. 国际化与主题规范
- 国际化采用 vben 内置的多语言方案，所有文案均需抽离至
locales/目录下。 - 主题切换建议基于 Ant Design Vue 的主题能力，支持暗色/亮色模式。
- 不同语言、主题下的 UI 效果需自测，保证一致性。
5. 推荐最佳实践
- 充分利用 vben-admin 提供的权限管理、动态路由、菜单、缓存、标签页等能力。
- 业务开发优先复用官方/社区组件，减少重复造轮子。
- 重要业务流程、核心组件需补充单元测试。
- 文档与注释齐全，便于团队协作和后期维护。
- 关注 vben-admin 官方文档和社区动态，及时跟进最佳实践和安全更新。
参考资料：