怎么使用dumi搭建一个属于自己团队的React组件库

怎么使用dumi搭建一个属于自己团队的React组件库

兰涛 lands

前言

我们在项目的开发过程中都会有大量的组件,然而在多个项目中,会导致这些组件来回 copy。所以我们需要搭建自己的组件库。本文采用 dumi 为组件库的框架,其中包括组件库的文档,以及怎么发布在私有库。

项目地址

源码地址

文档地址

项目介绍

在上文的组件库中,封装了算是我这两年来在 B 端开发比较常用的主键,附带了使用方式,如果不喜欢可以自行将这些组件删除。这些组件都是基于antdantd proComponent开发的,能很大的提升开发效率。

项目启动

在此也邀请有兴趣的小伙伴一起参与组件的共建。将项目clone后,使用pnpm i npm start启动。

项目介绍

这个项目没什么好介绍的,主要就是封装组件,然后将组件导出,dumi 官方地址 。如果有小伙伴想搭建自己的组件库,也可以将这儿的项目源码克隆下来,然后将内部的所有组件全部删除自己封装

前期工作

搭建 npm 私有库

搭建自己的 npm 私有库,我这里推荐使用verdaccio 搭建一个自己的 npm 私有库,使用 docker,非常简单。按着我给出的链接操作就可以了。

  1. 搭建完成后使用npm login --registry http://{ip}:4873登录到私有库
  2. 使用  npm config set --global @lands:registry=http://{ip}:4873,或者在项目中  .npmrc  文件写入  @lands:registry=http://{ip}:4873/

具体操作可以查看我的这篇文章
搭建一个企业私有的 npm 私有库服务

组件发布流程

组件发布流程

  1. 使用 npm login --registry https://npm.lantao.work 登录到私有仓库
  2. 发布前需修改版本号
  3. 测试发布使用 0.0.1-beta.1 形式,正式发布去掉-beta.1
  4. 正式发布需要再/docs/log/index.md 注明发布的内容
  5. 使用 npm publish --registry https://npm.lantao.work 发布到私有仓库
  6. 使用 npm run docs:build 打包组件文档项目
  7. 将组件文档发布到 linux:
  8. 将生成的 lands-react-component-doc 部署到服务器,可以选择创建一个自动化工程发布。

效果图



  • 标题: 怎么使用dumi搭建一个属于自己团队的React组件库
  • 作者: 兰涛
  • 创建于 : 2023-12-01 15:45:37
  • 更新于 : 2024-01-26 09:52:47
  • 链接: https://lands.work/818c9b8e/
  • 版权声明: 本文章采用 CC BY-NC-SA 4.0 进行许可。
评论
此页目录
怎么使用dumi搭建一个属于自己团队的React组件库