将 Vue 组件库发布到 npm
2023-09-27 14:26:44 时间
制作了一套自己的组件库,并发布到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
下载自己写的组件库了。
相关文章
- vue环境下安装npm,启动npm 修改js,css样式
- Vue 命令行工具 Vue-CLI 详解
- 【Vue】【子组件】调用【父组件】参数,props属性值【动态】调用的两种方法(图文+完整代码)
- 【Vue】非单文件组件的全局组件和局部组件示例(图文+完整代码)
- 【Vue】单击click事件综合示例和防冒泡方法
- Vue - Router 路由跳转传参(对象 / 数组)目标页面刷新后参数丢失问题解决方案
- vue中使用localStorage存储信息
- vue you can run: npm install --save !!vue-styles-loader!css-loader?
- vue使用注意事项:v-for和v-if不要一起使用 kathyb24
- vue-router编程式跳转
- 解决vue项目运行过程中,npm run dev 报错问题
- vue基础---列表渲染
- Vue 安装“npm install -g @vue/cli”发生npm WARN deprecated request@2.88.2: request has been deprecated,的错误解决方法
- Vue-插槽的使用
- 剖析 Vue.js 内部运行机制 (1)
- Vue基本的内置指令