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

徐小夕 等级 343 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

更多推荐

收藏
评论区

相关推荐

教你用200行代码写一个爱豆拼拼乐H5小游戏(附源码)
前言 本文将带大家一步步实现一个H5拼图小游戏,考虑到H5游戏的轻量级和代码体积,我没有使用react或vue这些框架,而采用我自己写的dom库和原生javascript来实现业务功能,具体库代码可见我的文章如何用不到200行代码写一款属于自己的js类库(https://juejin.im/post/6844903880707293198),构建工具我采
基于create-react-app打包编译自己的第三方UI组件库并发布到npm
前言 这篇文章主要是总结一下我们在工作中如何为公司开发内部的第三方UI组件,并通过npm install的方式安装的一些步骤和思路。在学习完这套发布方法后大家也可以快速的发布自己的UI库到npm,供他人使用,就比如elementUI或者Ant Design。 如果想学习如何发布一个js库或者框架,那么使用rollup更为适合,可以参考如下文章: 前端组
《前端实战总结》之使用解释器模式实现获取元素Xpath路径的算法
前端领域里基于javascript的设计模式和算法有很多,在很多复杂应用中也扮演着很重要的角色,接下来就介绍一下javascript设计模式中的解释器模式,并用它来实现一个获取元素Xpath路径的算法。 上期回顾 《前端实战总结》之迭代器模式的N1种应用场景(https://juejin.im/post/6844904008616771591)
JavaScript设计模式之英雄联盟
作者:黄梵高 原文: https://juejin.cn/post/6844904165982879758 构造函数模式 简介 在Jav
【Electron】electron-vue 借助 element-ui UI 库助力桌面应用开发
前面文章我们讲过 electron 让可以用 HTML、JS、CSS 开发桌面应用程序。而 electronvue 是一个结合了 electron 与 vue 的套件。这样我们就能方便地使用 vue 快速开发桌面应用。但是,vue 只是在 js 这层面做了大量的便捷的操作。对 UI 并未过多涉及。此时如果您在开发过程中自己实现一套统一主题的 UI 视觉效果
VSCode 插件之 ESLint
vscodeeslint github.com/microsoft/v…(https://github.com/microsoft/vscodeeslint) 为了区分 npm ESLint 包和 VSCode 的 ESLint 插件,我把前者称为 npm ESLint,后者称为 vscodeeslint。 vscodeeslint 优先
问题 first path segment in URL cannot contain colon 的解决方案
目录问题解决 问题使用Golang开发流媒体服务器处理Post请求时,遇到了这个报错信息:2020/12/14 07:21:01 callback post failed2020/12/14 07:21:01 error::8080/api/callback: first path segment in URL cannot contain col
Virtual DOM 的原理与实现
只贴代码 不解释过程 勿喷 ; 环境搭建1.克隆$ git clone https://github.com/cvgellhorn/webpackboilerplate.git$ npm install $ npm install @babel/plugintransformreactjsx savedev2.配
Vue UI组件库对比与选择
主流组件库对比PC端| UI组件库名 | github star | 是否可自定义主题 | 是否支持vue3 | 发布时间 | 稳定性 | 贡献者 || | | | | | | || | | 可自定义 | 支持,beta版本,, | 201608,4年半 | 长期支持,最新两个
NPM如何只发布打包后的dist
首发于<a name"jv1sc"</a 前言因为项目要求,我写了一个基于 umirequest 的统一请求插件,但公司的私有库尚未搭建起来,虽然可以暂时通过 webpack alias 别名引用的方式解决,但为了其他同学能快速拉到我的插件,我只能暂时先只将 dist 上传到 npm 仓库上。<br /<br /一共有两种方式。 .npm
Vue组件(30)封装一下数据列表的控件
UI库的 table好像前端喜欢叫 table,而后端喜欢叫grid。就是现实数据的列表。当然table还有其他的含义,UI库的table也是有其他的功能的。而数据列表控件其实也没啥好封装的,各种功能UI库都提供了,一般使用也是很方便的,只是为了我的那种想法还是需要小小的封装一下。功能 锁定行列(UI库自带) 多选(整理)
React 之Virtual DOM 及内核
什么是 Virtual DOM?Virtual DOM 是一种编程概念。在这个概念里, UI 以一种理想化的,或者说“虚拟的”表现形式被保存于内存中,并通过如 ReactDOM 等类库使之与“真实的” DOM 同步。这一过程叫做。这种方式赋予了 React 声明式的 API:您告诉 React 希望让 UI 是什么状态,React 就确保 DOM 匹
私有依赖的打包与上传
首发于 <a name"2ro9T"</a 背景项目中有三四个私有依赖(只有 npm 包,无源码),包括我封装的一些插件组件,需要上传到 npm 私有库,提供给其他同事组们使用。<br /<br /公司已有 npm 私有库,使用的是 Nexus Repository Manager,上传的方式是:提交 tgz 格式的依赖包。最开始当初的我,
11个基于vue的UI框架_U.R.M.L
Element UI 来自中国,由与 Mint UI 相同的开发者所创建。Element UI 是用于 Web 和桌面应用程序的桌面 UI 工具包,如果你需要开发 Electron 应用,这个库会是你的理想之选。 iView 是一个 UI 工具包,其中包含简洁又设计优雅的小部件和各种组件。iView 团队维护非常及时,最近一次的更新在19年3
SCF构建小型服务端并结合uni-app
使用腾讯云SCF构建小型服务端并结合uniapp()小程序我们这里手写了一个nodejs环境下的用户体系使用了之前写的一个数据库连接插件dmhqmysqlpool比较垃圾 凑合用文档地址为 也使用了md5 npm install jsmd5这里使用邮箱发送验证码先在本地写好 再上传云函数 配置数据库连接安装 npm install dmhsqmysqlpo