将 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.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下载自己写的组件库了。

原文地址:https://segmentfault.com/a/1190000013297807

原文地址:https://www.cnblogs.com/lalalagq/p/9921943.html

时间: 2024-08-29 11:08:51

将 Vue 组件库发布到 npm的相关文章

如何打造一套vue组件库

开篇组件库能帮我们节省开发精力,无需所有东西都从头开始去做,通过一个个小组件拼接起来,就得到了我们想要的最终页面.在日常开发中如果没有特定的一些业务需求,使用组件库进行开发无疑是更便捷高效,而且质量也相对更高的方案. 目前的开源组件库有很多,不管是react还是vue的体系里都有很多非常优秀的组件库,比如我经常使用的就有elementui和iview.当然也还有其他的一些组件库,他们的本质其实都是为了节省重复造基础组件这一轮子的过程.也有的公司可能会对自己公司的产品有特别的需求,不太愿意使用开源

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

首先npm文档摆在这里: https://www.npmjs.cn/ 参考组件 https://github.com/rakuten-rex/rex-dropdownhttps://www.npmjs.com/package/react-slot “造轮子”是非常有效的学习方法.在熟练掌握API的搬运方法之后,我们可以通过自己“造轮子”来进一步掌握和理解更底层的知识.自己完成一个组件的开发之后,我们可以打包上传到 NPM 来分享自己的成果.在后面的步骤中,将会实现以下几个小目标: 配置开发环境

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

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

Vue组件库 VV-UI 开始接受PR啦,有兴趣小伙伴可以一起参与开源哦。

前言: 刚开源出来的VV-UI目前刚刚起步,组件不是很多,非常欢迎大家的pr和Star.项目地址: https://github.com/VV-UI/VV-UI演示地址: https://vv-ui.github.io/VV-UI/#/目前组件库已经引入meta-info管理单页面title meta link等常用的seo问题.回归正题,如何搭建一套基于Vue的组件库呢? 1. 环境准备 我们搭建组件库,需要准备一系列环境,首先我们要考虑一下问题: 脚手架如何搭建 如何规划目录结构 如何编写文

Vue组件库开发

市面上目前已有各种各样的UI组件库,比如 Element 和 iView,他们的强大毋庸置疑.但是我们面临的情况是需求越来越复杂,当它们不能再满足我们需求的时候,这个时候就有必要开发一套属于自己团队的组件库了. 为何要进行组件库开发 如果你所在的公司对于页面的样式没有什么要求,那么你只要随便拿一个组件库来用就行了,比如element.iView等等,不用再重复造轮子了: 如果你目前只有个人用一个组件,或者是只对个别组件有要求,那么只要在你的工程里面开发一个.vue单文件组件就可以了:如果你的团队

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

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

vue组件库(一):前期准备工作

前言 将近期项目内自行开发一个vue组件,做个总结,记录下自己的思维过程~~~ 正文 接到这个任务后,还是要做些准备工作的. 主要内容如下: 1.优化下所在团队前端开发流程 服务器搭建gitlab,采用git进行代码版本管理 服务器搭建npm私服(基于verdaccio) 2.继续学习webpack4 3.学习借鉴两个vue组件,element-ui和ant-desigin-vue 总结 很遗憾,所在团队前端开发流程不够规范和完善,想借此次组件开发,推一些前端的新技术并多多产出一些团队共享资源

仿探探卡片滑动vue封装并发布到npm

项目初始化使用 webpack-simple 方式比较方便和容易配置,原来的方式各种坑慎入 vue init webpack-simple vue-card-slide cd vue-card-slide npm run dev 项目结构如下所示 更改webpack.config.js配置 entry: './src/lib/index.js', output: { path: path.resolve(__dirname, './dist'), publicPath: '', filename

Vue 组件库 Element 脚手架 入门教程

https://blog.csdn.net/u012359995/article/details/79702157 前提是安装了nodejs(6.0+),npm 验证安装成功 node –version npm –version Element官网地址: http://element-cn.eleme.io/#/zh-CN Element 脚手架 代码git地址: https://github.com/ElementUI/element-starter.git git clone下来后,进入el