如何创建一个前端 React 组件并发布到 NPM

首先npm文档摆在这里:

https://www.npmjs.cn/

参考组件
https://github.com/rakuten-rex/rex-dropdown
https://www.npmjs.com/package/react-slot

“造轮子”是非常有效的学习方法。在熟练掌握API的搬运方法之后,我们可以通过自己“造轮子”来进一步掌握和理解更底层的知识。自己完成一个组件的开发之后,我们可以打包上传到 NPM 来分享自己的成果。在后面的步骤中,将会实现以下几个小目标:

  1. 配置开发环境
  2. 开发组件
  3. 打包组件,并在测试项目中引入打包组件模块,验证组件功能
  4. 发布到 NPM

初始化

开始一个最基本的 React 工程,我们至少需要以下几项配置:

  • React: 用于开发组件
  • React dom: 渲染组件
  • Babel: 用于转义 JSX
  • webpack: 打包组件

我在这个例子里面做了一个叫做 react-tiny-autosuggest 的组件。首先创建 project 并且初始化。

mkdir react-tiny-autosuggest
cd react-tiny-autosuggest
npm init -y

这里我们需要改动三个地方:

  • main: 这里是我们组件的入口文件。开发者在 import 我们的组件的时候会引入这里 export 的内容
  • files: 申明将要发布到 npm 的文件。如果省略掉这一项,所有文件包括源代码会被一起上传到 npm
  • scripts: 申明命令行可用的各种指令。
// package.json

...
"main": "dist/bundle.js",
"files": ["dist"],
"scripts": {
    "start": "webpack-dev-server --config webpack.dev.config.js",
    "dev": "webpack-dev-server --config webpack.dev.config.js",
    "build": "webpack --config webpack.prod.config.js"
  },
...

接下来安装依赖

npm i react react-dom
npm i -D  babel-loader @babel/core @babel/preset-env @babel/preset-react webpack webpack-dev-server webpack-cli html-webpack-plugin webpack-node-externals css-loader style-loader

依赖版本的升级很快,所以如果读者发现依赖有问题,请参考官方文档正确安装。这篇文章最开始写于2018年初,到年之后更新的时候,好几个依赖都经过大更新了。

接下来配置 webpack。这里分成两份配置,一份用于开发环境(development),一份用于单独打包组件用于生产环境(production)。

在开发环境下,我们需要搭建一个完整的项目,让我们可以开发组件,并可以将其引入其他组件,渲染到浏览器中看到效果。同时我们也需要一些开发工具的支持,比如 HMR(hot module reloa) 组件热更新和详细的报错信息。

在生产环境下,只需要打包组件本身,不包括工程里面的其他组件。同时我们需要压缩文件体积,尽量减小组件打包之后的体积。

Webpack 配置

下面是我们的 webpack 开发配置

const path = require(‘path‘);
const htmlWebpackPlugin = require(‘html-webpack-plugin‘);

module.exports = {
  mode: ‘development‘,
  entry: ‘./src/app.js‘,
  output: {
    filename: ‘bundle.js‘,
    path: path.resolve(__dirname, ‘../dist‘),
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        use: ‘babel-loader‘,
        exclude: /node_modules/
      },
      {
        test: /\.css$/,
        use: [‘style-loader‘, ‘css-loader‘]
      },
      {
        test: /\.cm\.styl$/,
        loader: ‘style-loader!css-loader?modules&camelCase&localIdentName=[local]-[hash:base64:5]!stylus-loader‘
      }
    ]
  },
  devServer: {
    contentBase: ‘./dist‘
  },
  plugins: [
    new htmlWebpackPlugin({
      template: ‘public/index.html‘
    })
  ],
};

production 打包配置,区别是改变了 entry,因为我们只需要单独的组件,并且改变了 libraryTarget,这个配置项的默认参数是 ‘var‘,我们需要改成 commonjs2,这样可以通过模块系统引入这个组件。另一点区别是使用了 nodeExternals 使得打包的组件中不包括任何 node_modules 里面的第三方组件,起到减小体积的作用。

const path = require(‘path‘);
const nodeExternals = require(‘webpack-node-externals‘);

module.exports = {
  mode: ‘production‘,
  entry: ‘./src/autosuggest.js‘,
  output: {
    filename: ‘bundle.js‘,
    path: path.resolve(__dirname, ‘../dist‘),
    libraryTarget: ‘commonjs2‘
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        use: ‘babel-loader‘,
        exclude: /node_modules/
      },
      {
        test: /\.css$/,
        use: [‘style-loader‘, ‘css-loader‘]
      },
      {
        test: /\.cm\.styl$/,
        loader: ‘style-loader!css-loader?modules&camelCase&localIdentName=[local]-[hash:base64:5]!stylus-loader‘
      }
    ]
  },
  externals: [nodeExternals()]
};

在 package.json 中,我们可以通过 --config 指定 webpack 使用哪一套配置。在这个 demo 里使用了 stylus 来写样式文档,所以添加了相应的 css pre-processor,把 stylus 语法 转化为 css 语法。并且在引入 css 的时候使用了模块化 css 以避免全局命名冲突。

.babelrc

{
  "presets": ["@babel/preset-env", "@babel/preset-react"]
}

开发组件

完成以上配置以后,我们可以在 src 文件夹里面开发自己组件。运行 npm run dev,让 webpack-dev-server 渲染到浏览器中,实时看到效果。

打包并验证

打包组件,只需要运行 npm run build 就可以了。
接下来可以通过 npm link 把打包之后的组件引入到 global node_modules 中,然后在验证 demo 中再通过 npm link react-tiny-autosuggest 引入这个组件,并验证是否符合预期。

// At development directory
npm run build
npm link

cd [test project folder]
npm link react-tiny-autosuggest

接下下 demo 里面就可以直接 import AutoSuggest from ‘react-tiny-autosuggest‘了。

发布到 NPM

发布组件到 npm: npm publish

取消发布: npm unpublish

更行版本: 更改 package.json 里面的版本号并重新发布

原文地址:https://www.cnblogs.com/thinkingthigh/p/11603962.html

时间: 2024-10-09 01:16:17

如何创建一个前端 React 组件并发布到 NPM的相关文章

webpack 打包一个简单react组件

安装Webpack,并加载一个简单的React组件 全局的npm模块安装: npm install -g webpack 安装jsx-loader npm install --save-dev jsx-loader 默认使用当前目录的自己新创建的webpack.config.js作为配置文件 module.exports = { entry: [ './assets/js/entry.js' ], output: { path: __dirname + '/assets/', publicPat

Azure创建一个.NET CORE简单页面发布并监控接口状态

介绍主题:Azure 大家都知道Azure云现在由于中国国策不一样,会有中国版Azure云和国际版Azure. 但是我们今天会围绕这个国际版的讲,因为我们这个演讲会比较international一点. 由??运营的 世纪互联是中国最大的第三方电信中立互联网基础设施服务提供商之一,提供托管及相关服务.管理托管网络服务和云计算基础设施服务,不断改善其互联网基础设施平台,实现用户互联网连接的高可靠性.高安全性和高速性. Azure云简单来说到底是个什么东西? 平时经常说 Azure Azure 云 啊

vue组件篇(2)---封装组件并发布到npm

瞎说说 vue小白,要进行应用开发:你们都用什么UI框架,求指教,不想踩坑(想太多,不踩坑???不存在的!!!too young too simple-) 同学1:pc端我用element UI,感觉组件的API方法.属性比较完善...?? 同学2:哈?我个人感觉他的样式有些生硬,不够炫酷美观??,用iView吧,组件丰富,动画效果cool~~~?? 同学3:真的吗?阔是有人说,iView组件虽然完美的把其他UI组件有的缺点完美避过,但是某某组件不够人性化....?? 同学4:用vue-beau

将自己的组件打包发布到npm

在项目中有些组件在各个项目中都会调用,那么将组件发布到npm ,用到的项目去下载,这样会省去一些不必要的麻烦. 将组件发布到npm 中的步骤 做个记录 1.项目的创建,我这里使用 vue init webpack-simple 项目名 2修改文件目录 , 创建 components 文件夹 创建 main.vue  在根目录创建 index,js 3.修改文件内容 和配置 main.vue是一个组件  就按照组件的格式去写 index.js  的内容 注意引用的组件中一定要写name 属性 在组

将 Vue 组件库发布到 npm

制作了一套自己的组件库,并发布到npm上,项目代码见 GitHub . 前期准备 有一个npm账号 安装了vue-cli 搭建项目 vue init webpack hg-vcomponents cd hg-vcomponents cnpm install 目录结构 - vue-flag-list + build + dist // 存放发布到npm的代码 - src - components // 存放组件源代码 和 README.md - arrows arrows.vue README.m

我想写一个前端开发工具(一):在npm发布模块

有必要说说我为什么要开始写这个 我最近忙于公司的项目,一直没有抽出时间来写文章.本来想每个月写一片文章,保质保量,无奈上个月没有坚持. 这段时间有点忙,主要是由于公司业务调整,我从原来的广告项目中调整到新业务线的前台页面开发了,和以前一样,还是带着3.4个兄弟姐妹.不同的是以前的项目周期普遍偏长,可以让每个同学有时间从头到尾的把项目吃透,而现在做C端的前台页面往往开发时间非常的短,比如我们就要在1.2个月完成业务线所有前台页面的开发.联调.测试.部署,以及下一步的迭代.由于是从零开始,不存在基于

【转】从零开始开发一个vue组件打包并发布到npm (把vue组件打包成一个可以直接引用的js文件)

自己写的组件 有的也挺好的,为了方便以后用自己再用或者给别人用,把组件打包发布到npm是最好不过了,本次打包支持 支持正常的组件调用方式,也支持Vue.use, 也可以直接引用打包好的js文件, 配合vue.js 就不需要webpakc这种构建工具了,可以直接在页面内使用,下面以 ‘yyl-npm-practice’ 这个包为例 第一步:使用 vue init webpack-simple yyl-npm-practice   初始化项目 提示: 不要用 vue init webpack npm

vue封装插件并发布到npm上

vue封装插件并发布到npm上 项目初始化 首先,要创建项目,封装vue的插件用webpack-simple很合适,vue init webpack-simple 项目名称此命令创建我们的项目的目录,创建文件夹和文件,最后结构是这样的  然后根据需求,实现具体功能,这里我封装了一个轮播图组件mini-sliders,主要功能写在lib/slider.vue组件中 功能写好后,我们要写index.js来封装组件 import VueComment from './VueComment.vue' c

Mac os下换行符导致发布到npm里的命令行模块不能使用问题

学习node,弄一个命令行模块,发布到npm后,Windows安装后可以使用,但Mac 终端下则不行.对比grunt-cli搞了一夜,甚是郁闷,最后发现竟然是操作系统的换行符问题. npm install jdf -g 后,去安装目录 usr/local/lib/node_module/jdf/bin/jdf,用sublime打开该文件 选择 view>line endings>unix 这时再执行jdf就哦了 感谢永忠. 相关: http://blog.sina.com.cn/s/blog_