将 Vue 组件库发布到 npm
2023-09-11 14:22:49 时间
制作了一套自己的组件库,并发布到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.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
下载自己写的组件库了。
相关文章
- import Vue from 'vue';
- (尚031)Vue_案例_自定义事件(组件间通信第2种方式:vue自定义事件)
- 【Vue】npm install -g 和 npm install 区别
- [转]Vue CLI 3搭建vue+vuex 最全分析
- Vue中使用ECharts报错echarts Uncaught (in promise) TypeError: Cannot read property ‘getAttribute‘ of null
- Vue组件的操作-自定义组件,动态组件,递归组件
- vue对象追加对象
- vue生命周期之缓存过的页面刷新数据逻辑
- vue-cli3快速创建项目
- vue与node和npm关系
- 【Vue】vue基础语法——自定义指令、过滤、组件和动画(内附详细案例代码)——day04
- vue学习笔记七:Jquery VS Vue之杂项方法明细对照
- VUE的mixin混入解析
- Vue的实例属性和方法
- Vue动态组件
- Web 前端 之 Vue vue cli 环境的搭建简单整理(简单的一些注意事项)
- vue组件懒加载(Load On Demand)
- ejs结合vue实现SSR ,express+ejs+vue = 服务器端渲染 ?Vue-SSR的奇思妙想
- vue封装组件,类似elementUI组件库打包发布到npm上
- 【转】从零开始开发一个vue组件打包并发布到npm (把vue组件打包成一个可以直接引用的js文件)
- vue 登录页背景-粒子特效(Vue-Particles)