1.0.2 • Published 4 years ago
md-component v1.0.2
英文: oa-base-build
中文:oa组件开发脚手架
使用平台:PC
主要运行命令
# 安装依赖
npm install
# 开启服务(默认打开页面:localhost:8080)
npm run dev
# 生产环境
npm run build
架构引入npm
名字 | 中文说明 |
---|---|
element-ui | UI组件 |
less | css编译 |
使用方式
- 单独引入vue入口文件(目前采用这种方式,具体见src/demo.vue注释内容)
- 打包成npm组件包(这种方式使用vue.use()方式就可以了,不用单独引入组件, 具体见main.js入口注释内容)
组件开发规范
- 组件开发必须有README.md文件
- 组件开发尽量用es6开发,统一用箭头函数
- 引入第三方npm包,组件,头部必须有注释说明
- 遵守esline的开发规则(采用vscode中的esline插件)
- 组件如果存在多功能,同意建一个index.vue文件充当入口,其他组件引入的方式,可以达到解耦
- 组件最小的原则,尽量把一个大组件分离的原则去实现(每个小组件都有自己的state和template)
- vue组件开发尽量避免使用mixin
- element-ui统一使用局部引入,不要再架构里面全局引入element-ui
- 命名规则统一使用驼峰
- 组件名规范:统一需要写name,eg:oa-table
注意事项
- 不允许再master中开发
- 开发中在git新建版本分支,eg:1.0.0
- 上传代码前需要build一下,打包成一个包,为了后期可能需要在npm私服用
- 和数据相关的需要写上本地mock,不能依赖网络