更新记录
1.0.5(2024-01-17)
升级 vite4
1.0.4(2024-01-17)
引入env文件
1.0.3(2024-01-17)
增加cli 脚本,更换小程序,h5 环境变量引入方式 环境变量更改为 ENV 文件
查看更多平台兼容性
Vue2 | Vue3 |
---|---|
√ | √ |
App | 快应用 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ小程序 |
---|---|---|---|---|---|---|
app-vue | × | √ | × | × | × | × |
钉钉小程序 | 快手小程序 | 飞书小程序 | 京东小程序 |
---|---|---|---|
× | × | × | × |
H5-Safari | Android Browser | 微信浏览器(Android) | QQ浏览器(Android) | Chrome | IE | Edge | Firefox | PC-Safari |
---|---|---|---|---|---|---|---|---|
√ | √ | √ | √ | √ | √ | √ | √ | √ |
vue3-uniapp-engineering
介绍
一套完整,规范的基于vue3,vite,eslint,commitlint,uniapp的工程环境
架构目录说明
- .husky git提交钩子
- pages 页面组件
- api 接口管理
order.js为使用事例
- common 公共类
- const.js 全局常量
- envConfig 环境变量
- uviewConfing uview全局配置
- components 公共组件
- static 静态文件
- h5 h5环境变量
- mp-weixin 小程序环境变量
- uni_modules ui组件
- utils 工具类
- .cz-config git提交配置
- .eslintrc eslint配置
架构配置说明
集成 EditorConfig 配置
处理同意项目多个开发人员维护一致的编码风格 官网:editorconfig.org.
集成 Prettier 配置
官网:prettier.io.
集成eslint
官网:eslint
集成husky
官网:husky git hooks工具,可以设置git在各个阶段的触发命令
集成lint-staged
官网:lint-staged 在 git 暂存的文件上运行 linters。
安装教程
-
npm i
-
自定义启动命令
npm run dev:custom "h5-dev/h5-test/h5-pro" npm run build:custom "h5-dev/h5-test/h5-pro"
常见问题
- git cz 无命令 (全局安装commitizen)
npm install commitizen -g
使用说明
- git cz 无命令 (全局安装commitizen)
-
使用vscode进行开发,安装Prettier插件
-
git 提交规范,参考Angular提交规范
fix(other):修改 commit-msg执行脚本
-
命令行使用git cz进行提交
-
可视化工具进行项目提交也会触发,husky
-
vue2项目,请自行修改vite.config.js