hmh-plugin

+ form-design 表单设计组件 + people-select 人员选择组件

Usage no npm install needed!

<script type="module">
  import hmhPlugin from 'https://cdn.skypack.dev/hmh-plugin';
</script>

README

海米汇公共组件

组件列表

  • form-design 表单设计组件
  • people-select 人员选择组件

开发说明

  • 采用VueCLI V4.* 只是方便在此项目中开发调试组件,不用于此项目打包。注意: 此项目中采用 normalize.css 重置默认样式,如果在此项目中开发调试组件,并查看效果,请注意组件样式显示
  • 组件 放于 packages 文件夹下;
  • 组件所有外部公共依赖(如 elementUI vux axios 等通用运行依赖,不会打包到组件内), 如非必要,不用在组件内单独引入
  • 因此库只是常用组件集,style样式 请在各自组件内自行维护
  • 不要在组件内使用 @ 等别名,在组件内引用非 node_modules 内容,用相对路径
  • 组件开发维护者务必在组件内添加 README.md文件,并说明组件接口文档,依赖配置等
  • 组件如非必要,不要污染全局环境!!。

关于 packages

.
└── packages
    └── components-demo  # 组件名称 组件名称需要小写字母以及短线命名 组件名称标识,唯一
        ├── index.js # 组件入口
        └── src # 组件源码
            └── index.vue # 组件入口文件

关于 package.json

  • 如果引入开发依赖,请安装在 devDependencies;
  • 如果是通用运行依赖宿主包, 请安装在 devDependencies peerDependencies;
  • 只是此组件运行依赖,请安装在 dependencies;

关于开发分支

  • 个人开发可从 master 分支上创建本地分支,开发完成测试无问题后,可合并到 master 分支上上传, 个人开发分支如非必要,不用上到 origin 远程库
  • master 分支上代码暂做为生产分支,不应在 master 分支上开发,不要向 master 分支上上传未测试过的代码

使用

  • 直接引用 packages 内源代码, 注意在 webpack 中添加配置 babel 编译 node_modules/haimihui-plugin 这个库
  • 如使用 lib 下打包后文件,请注意引用组件的依赖配置

关于版本发布 !!! 重要 !!!

  • 如果涉及到 接口 api 变更,组件使用方也要做出更改的,发布大版本 ^ 不能兼容的版本
  • 如果只是更改 bug, 优化性能 不涉及到 api 变更,组件使用方不用做调整的,可发布小版本 ~ 兼容版本
  • 版本发布分支为 master 分支,发布前务必保证 本地代码与远程库同步,以免多人开发发布时出现代码问题 !!!!

TODO List

  • 组件打包
  • 工具库打包
  • 单元测试