更新记录

1.0.1(2022-08-05)

修改uview注入方式

1.0.0(2022-07-26)

1.0.0完整工程环境 集成eslint,editorconfig,prettier,husky,lint-staged,uview-plus

查看更多

平台兼容性

Vue2 Vue3
App 快应用 微信小程序 支付宝小程序 百度小程序 字节小程序 QQ小程序
3.5.1 app-vue × × × × ×
钉钉小程序 快手小程序 飞书小程序 京东小程序
× × × ×
H5-Safari Android Browser 微信浏览器(Android) QQ浏览器(Android) Chrome IE Edge Firefox PC-Safari
<!-- * @Author: CtrlC * @Date: 2022-07-26 17:54:30 * @LastEditors: CtrlC * @LastEditTime: 2022-08-05 15:08:18 * @Description: file content * @FilePath: /vue3-uniapp-engineering/README.md -->

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。

    安装教程

    1. npm i
    2. 自定义启动命令
      npm run dev:custom "h5-dev/h5-test/h5-pro"
      npm run build:custom "h5-dev/h5-test/h5-pro"

      使用说明

    3. 使用vscode进行开发,安装Prettier插件
    4. git 提交规范,参考Angular提交规范 fix(other):修改 commit-msg执行脚本
    5. 命令行使用git cz进行提交
    6. 可视化工具进行项目提交也会触发,husky
    7. vue2项目,请自行修改vite.config.js

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问