基于create-react-app打包编译自己的第三方UI组件库并发布到npm

徐小夕 等级 763 1 0

前言

这篇文章主要是总结一下我们在工作中如何为公司开发内部的第三方UI组件,并通过npm install的方式安装的一些步骤和思路。在学习完这套发布方法后大家也可以快速的发布自己的UI库到npm,供他人使用,就比如elementUI或者Ant Design。

如果想学习如何发布一个js库或者框架,那么使用rollup更为适合,可以参考如下文章:

前端组件/库打包利器rollup使用与配置实战

实现效果

首先我们看一下实现效果,比如我们本地开发了一个Tag组件:

基于create-react-app打包编译自己的第三方UI组件库并发布到npm 蓝色的按钮就是我们的tag组件,接下来我们把它发布到npm上,效果如下:

此时我们就可以用npm install的方式安装我们的组件并使用了。

实现

首先我是基于create-react-app来打包我们的UI库的,因为比较方便简单,当然我们也可以使用自己搭建的webpack来实现这一过程。

1.通过create-react-app快速启动一个项目:

npx create-react-app alex_xu
cd alex_xu
npm start

2.设计组件库目录结构

我们在create-react-app创建的项目下的src目录下新建components用来存放我们的组件,用app.js要导入我们的组件来测试效果,我们会把打包后的组件目录放在lib下,目录大致如下:

基于create-react-app打包编译自己的第三方UI组件库并发布到npm

3.配置package.json文件

package.json主要用来设置组件库的信息及打包脚本,就好比我们用vue/react脚手架搭建项目一样,大家应该都很熟悉了:

{
  "name": "@alex_xu/ui",
  "version": "0.0.1",
  "description": "A Design UI library for React",
  "main": "lib/index.js",
  "module": "es/index.js",
  "author": "alex_xu",
  "private": false,
  "license": "MIT",
  "publishConfig": {
    "registry": "你的npm仓库地址"
  },
  "repository": {
    "type": "git",
    "url": "git+你的git仓库地址"
  },
  "bugs": {
    "url": "issues地址"
  },
  "files": [
    "es",
    "lib"
  ],
  "homepage": "组件库的主页",
  "keywords": [
    "react",
    "components",
    "ui",
    "framework",
    "frontend"
  ],
  "peerDependencies": {
    "react": ">=16.5.0",
    "react-dom": ">=16.5.0"
  },
  "scripts": {
    "start": "node scripts/start.js",
    "build": "node scripts/build.js",
  },
  "eslintConfig": {
    "extends": "react-app"
  },
  "browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  },
  "devDependencies": {
    "@babel/cli": "^7.6.4",
    "@babel/core": "^7.6.4",
    "@babel/plugin-syntax-dynamic-import": "^7.2.0",
    "@babel/preset-env": "^7.6.3",
    "@babel/preset-react": "^7.6.3",
    "babel-plugin-import": "^1.12.2"
  },
  // ...
}

这里的script配置只是运行时配置,打包的时候我们会写单独的配置脚本去执行打包,然后打包jsx语法我们需要手动配置babel,所以我们会安装babel插件,babel配置如下:

const presets = [
    [
        "@babel/preset-env",   // 将ES6语法转换为es5
        {
            "useBuiltIns": "usage",    // 只编译需要编译的代码
            "corejs": "3.0.1",
        }
    ],
      "@babel/preset-react"
];

const plugins = [
    "@babel/plugin-syntax-dynamic-import",
    ["import", { "libraryName": "antd", "style": true }]
]

module.exports = { presets, plugins }

接下来安装babel模块:

npm i @babel/cli @babel/core @babel/preset-env @babel/preset-react -D

这里为了设置兼容多平台的环境变量,我们还需要用到cross-env, 拷贝css需要cpx,

npm i cross-env cpx -D

需要安装的插件已经完成,现在可以写打包组件的shell脚本了(建议在在根目录下创建):

cross-env BABEL_OUTPUT=commonjs babel src/components --out-dir lib/
babel src/components --out-dir es/
# 拷贝css
cpx \"src/components/**/*.css\" es"
cpx \"src/components/**/*.css\" lib"

接下来我们继续我们的组件库发布.

4.发布组件库

首先假定我们在components下写好了第一个组件Tag,我们在components的index.js统一导出:

export { default as Tag } from './Tag';
// ...

然后执行我们的shell脚本:

bash build.sh

执行完可以发现在根目录下多了lib和es的目录,里面即使我们打包后的组件,一种遵循es规范,一种遵循cjs规范.

发布:

npm publish --access public

--access是设置npm的访问级别,有public|restricted, restricted是限制访问,如果要发开源包,一般设置为public.

最后

完整配置文件我已经发布到github,如果想了解更多webpack,gulp,css3,javascript,nodeJS,canvas等前端知识和实战,欢迎在公众号《趣谈前端》加入我们一起学习讨论,共同探索前端的边界。

基于create-react-app打包编译自己的第三方UI组件库并发布到npm

更多推荐

收藏
评论区

相关推荐

基于create-react-app打包编译自己的第三方UI组件库并发布到npm
前言 这篇文章主要是总结一下我们在工作中如何为公司开发内部的第三方UI组件,并通过npm install的方式安装的一些步骤和思路。在学习完这套发布方法后大家也可以快速的发布自己的UI库到npm,供他人使用,就比如elementUI或者Ant Design。 如果想学习如何发布一个js库或者框架,那么使用rollup更为适合,可以参考如下文章: 前端组
NPM如何只发布打包后的dist
首发于<a name"jv1sc"</a 前言因为项目要求,我写了一个基于 umirequest 的统一请求插件,但公司的私有库尚未搭建起来,虽然可以暂时通过 webpack alias 别名引用的方式解决,但为了其他同学能快速拉到我的插件,我只能暂时先只将 dist 上传到 npm 仓库上。<br /<br /一共有两种方式。 .npm
私有依赖的打包与上传
首发于 <a name"2ro9T"</a 背景项目中有三四个私有依赖(只有 npm 包,无源码),包括我封装的一些插件组件,需要上传到 npm 私有库,提供给其他同事组们使用。<br /<br /公司已有 npm 私有库,使用的是 Nexus Repository Manager,上传的方式是:提交 tgz 格式的依赖包。最开始当初的我,
SCF构建小型服务端并结合uni-app
使用腾讯云SCF构建小型服务端并结合uniapp()小程序我们这里手写了一个nodejs环境下的用户体系使用了之前写的一个数据库连接插件dmhqmysqlpool比较垃圾 凑合用文档地址为 也使用了md5 npm install jsmd5这里使用邮箱发送验证码先在本地写好 再上传云函数 配置数据库连接安装 npm install dmhsqmysqlpo
AT
![](https://oscimg.oschina.net/oscnet/9bcf9c4a197687d0f09aa8b0d010e9470c7.jpg) AT-UI 是一款基于 Vue 2.x 的前端 UI 组件库,主要用于快速开发 PC 网站产品。 没错,这是又一款基于 Vue 的前端 UI 组件库,又双叒叕款 UI 库~又双叒叕款轮子
NPM 私库从搭建到数据迁移最后容灾备份的一些解决方案
👆   这是第  80  篇 不掺水的原创 ,想要了解更多 ,请戳上方蓝色字体: 政采云前端团队  关注我们吧~ > 本文首发于政采云前端团队博客:NPM 私库从搭建到数据迁移最后容灾备份的一些解决方案 > > https://www.zoo.team/article/set-up-the-npm-private-library ![](https:/
Android史上最好的日历,是怎样设计开发的?
[首先放出码云仓库地址](https://gitee.com/huanghaibin_dev/CalendarView "码云仓库地址") ##### 对于开源的UI库,最突出的特点莫过于以下三点 * UI方便自定义 * 性能要优秀 * 功能要强大 ##### 记得2017年的时候,我从github、git上寻
EventBus
关于Eventbus的问题 1.线程只要非UI线程和非UI线程就可以了,为什么EventBus中要有好几种Threadmode呢?这有什么好处? 2.EventBus的post方法是怎么调用相应register的相应方法的? `4月18日重新又看下代码` private void postToSubscription(Subscription
Mint UI文档
Mint UI文档:[http://elemefe.github.io/mint-ui/#/](https://www.oschina.net/action/GoToLink?url=http%3A%2F%2Felemefe.github.io%2Fmint-ui%2F%23%2F) 一、Mint UI的安装和基本用法。 1.**NPM :**npm i
Node.js学习笔记(二、NPM 使用)
介绍 == NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种: * 允许用户从NPM服务器下载别人编写的第三方包到本地使用。 * 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。 * 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。
Node连接MySQL数据库及相关操作
**首先使用npm安装mysql包:** $ npm install mysql **连接数据库:** var mysql      = require('mysql');   //引入mysql包 //创建数据库连接 var connection = mysql.createConnection({   host     : 'localhos
Qt编写数据可视化大屏界面电子看板12
一、前言 ---- 数据采集是整个数据可视化大屏界面电子看板系统核心功能,没有数据源,这仅仅是个玩具UI,没啥用,当然默认做了定时器模拟数据,产生随机数据,这个可以直接配置文件修改来选择采用何种数据采集方法,总结了一下基本上会有这样几种数据源,timer-模拟数据 db-数据库采集 tcp-网络采集 http-post请求,大量的web会选择采用http作
Vue CLI 3搭建vue+vuex 最全分析
一、介绍 ==== Vue CLI 是一个基于 Vue.js 进行快速开发的完整系统。有三个组件: **CLI**:`@vue/cli` 全局安装的 npm 包,提供了终端里的vue命令(如:vue create 、vue serve 、vue ui 等命令) **CLI 服务**:`@vue/cli-service`是一个开发环境依赖。构建于 [we
springboot+vue 登录页面(一)
首先了解的技术点是: 后台:springboot,mybatis,mybatis逆向工程,mysql,日志 前端: nodejs,npm ,cnpm,vue,vue-cli,webpack,element ui,router,axios 开发工具:idea,webstorm 该项目前端使用的是vue ,目的是实现前后端分离 后台: 1.选择spr
vue+element UI + axios封装文件上传及进度条组件
1.前言 ==== 之前在做项目的时候,需要实现一个文件上传组件并且需要有文件上传进度条,现将之前的实现过程简单记录一下,希望可以帮助到有需要的人。 项目用的是Vue框架,UI库使用的是element UI,前后端交互请求使用的是Vue官方推荐的axios。其中,UI方面主要使用了element UI库中的`Upload`文件上传组件、`Progress