Vue组件库发布到npm详解

更新时间：2018年02月17日 08:46:12 投稿：laozhang

本片文章给大家详细介绍了如何将Vue组件库发布到npm的方法以及代码示例分享，感兴趣的朋友参考学习下。

制作了一套自己的组件库，并发布到npm上，项目代码见https://github.com/hamger/hg-vcomponents

前期准备

有一个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.md
       - round
        round.vue
         README.md
      index.js // 组件导出文件
    - examples // 存放组件的 demo
      arrows.vue
       round.vue
       index.vue // 组件 demo 的入口
     - router
       index.js // 引入 examples 下的组件，并配置路由
     App.vue
     main.js
   ...

内部代码详见 GitHub，如果对你有所帮助，给个star吧。

项目配置

为了使项目能上传到npm上，需要配置一些地方。

build/webpack.base.conf.js

entry: {
  app: process.env.NODE_ENV === 'production'
   ? './src/components/index.js' // 生产模式下导入文件
   : './src/main.js' // 开发模式下导入文件
},

package.json

"private": false, // 因为组件包是公用的，所以 private 为 false
"main": "dist/hg-vcomponents.min.js", // 导出文件名，即 import 引入的文件

.gitignore

dist文件夹下文件是要导出的文件，所以在.gitignore文件中把dist/去掉，这样上传代码的时候也会更新打包后的文件。

开发与生产

由于配置了webpack.base.conf.js，使得项目的开发与生产独立开来。

使用npm run dev进入开发环境，就可以看到组件的demo，方便调试。使用npm run build打包组件库。

发布到npm

在你登录了npm的情况下，在根目录输入命令行(每次更新代码执行同样操作)

npm version patch
npm publish

大功告成！现在你可以在其他地方使用npm install hg-vconponents下载自己写的组件库了。

您可能感兴趣的文章:

WEB前端性能优化的7大手段详解
本文将详细介绍前端性能优化的7大手段，包括减少请求数量、减小资源大小、优化网络连接、优化资源加载、减少重绘回流、使用性能更好的API和构建优化
2020-02-02
Vue.js 使用v-cloak后仍显示变量的解决方法
这篇文章主要介绍了Vue.js 使用v-cloak后仍显示变量的解决方法 ,文中给大家提到了v-cloak的用法，需要的朋友可以参考下
2018-11-11
用vue的双向绑定简单实现一个todo-list的示例代码
本篇文章主要介绍了用vue的双向绑定简单实现一个todo的示例代码，具有一定的参考价值，有兴趣的可以了解一下
2017-08-08
element表格翻页第2页从1开始编号(后端从0开始分页)
这篇文章主要介绍了element表格翻页第2页从1开始编号(后端从0开始分页)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12
Vue通过封装全局获取焦点指令
这篇文章主要为大家详细介绍了Vue通过封装全局获取焦点指令的相关知识,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考下
2023-12-12
Vue3+Vite+TS使用elementPlus时踩的坑及解决
这篇文章主要介绍了Vue3+Vite+TS使用elementPlus时踩的坑及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-10-10
vue.js中proxyTable 转发请求的实现方法
今天小编就为大家分享一篇vue.js中proxyTable 转发请求的实现方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-09-09
vue2中less的安装以及使用教程
less是css预处理器,对原先css进行了扩展和补充,下面这篇文章主要给大家介绍了关于vue2中less的安装以及使用的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-12-12
ant-design-vue按需加载的坑的解决
这篇文章主要介绍了ant-design-vue按需加载的坑的解决，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-05-05
vue2.x中monaco-editor的使用说明
这篇文章主要介绍了vue2.x中monaco-editor的使用说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-08-08