业务组件库必要性
我的项目通过长期保护之后往往会积淀出很多公共组件,当一个组件编写实现之后,其余维护者想要应用这个组件,理解这个组件是做什么的,应该怎么用,必须再去翻看源码,或者没有压根儿留神到这个组件导致重发开发。这个时候一个欠缺的组件库就很有必要了,能够保障开发者之间进行良好的合作。
组件库能够帮咱们解决以下问题:
- 业务组件跨我的项目复用,晋升开发效率
- 对立代码实现,对立代码品质保障
- 组件库文档提供清晰的应用形式和直观的展现成果
组件库的组成
业务组件形成
业务组件库是基于根底组件库进行编写的,根底组件库是应用 antd。咱们会对根底组件针对不同需要进行封装,达到能够间接援用无需二次开发的目标 (比方:下拉抉择组件,咱们会将接口申请数据、选项含糊查问、多语言等封装到组件外部,无需二次开发,接口申请也不须要再散落到各个页面中)。
指标
- 引⼊即可使⽤,⽆需⼆次开发
- 欠缺的文档和组件成果演示,反对代码一键拷贝
- 良好的代码品质:应用 Jest 进行单元测试,保障代码品质
- 良好的编码标准和代码提交标准:ESLint、Husky、commit-lint 等工具进行校验和拦挡
- 依据代码提交主动生成 ChangeLog
- 组件成果演示反对编辑实时渲染 (在文档中编辑组件,实时变更展现成果)
开发计划
组件库开发周期
-
筹备
- 组件库文档选型评审
- 首批组件梳理
-
开发
- 本地预览调试
- 本地构建
- Jest + @testing-library
- 目录构造标准
- 本地开发环境构建
- 代码标准校验
- 代码提交标准校验
- CR 和公布标准
- TypeScript 反对
- 单元测试
- 组件开发
- 组件库文档生成
-
首次公布
- 公布和应用首次版本
-
迭代降级
- 在线拜访
- 业务组件新增
- 业务组件迭代
- 组件库文档托管
-
可视化构建页面区块和页面