npm发布vue组件包

前言

   现在前端开发基本离不开npm插件包,有的时候自己写了一个组件在多个项目中都有用到,简单粗暴的做法就是CV大法啦。不过这种不系统,不易维护的做法我们是不在这里讨论的。这里我以实际开发项目做的一个vue组件来陈述。

开发环境

   vue-cli3.x+ (2.x的也差不多)

首先创建项目这个一张图描述了

创建项目

更改项目结构

   其实呢改不改都无所谓的,只不过改了看上去更牛逼些。我们把src目录改成example模块,在根目录下新增一个packages目录。新增一个vue.config.js文件、新增一个.npmignore文件


目录结构

packages 目录说明

   这里是存放我们要发布的组件,可能你要发布多个组件这里以组件名区分开,不过个人不建议把多个npm组件弄在一起,除非你是想做大工具库API,我个人推荐一个项目一个组件当然这个组件是独立的


packages结构
// package/vue-aliplay-player/index.js    // 抛出 vue-aliplay-player
import vueAliplayer from './src/player.vue'

 /**
  * 预览做全局组件使用,按需加载组件可以不需要这个install
  */
vueAliplayer.install = function(vue) { 
    Vue.component(vueAliplayer.name, vueAliplayer)
}
export default vueAliplayer

// packages/index.js  // 抛出所有组件,做多个组件使用 
import vueAliplayer from './vue-aliplay-player'

const components = [
    vueAliplayer
]

// 定义 install 方法,接收 Vue 作为参数。如果使用 use 注册插件,则所有的组件都将被注册
const install = function(Vue) {
    // 判断是否安装
    if (install.installed) return
    // 遍历注册全局组件
    components.map(component => Vue.component(component.name, component))
}

// 判断是否是直接引入文件
if (typeof window !== 'undefined' && window.Vue) {
    install(window.Vue)
}

export default {
    // 导出的对象必须具有 install,才能被 Vue.use() 方法安装
    install,
    // 以下是具体的组件列表
    ...components
}

打包前开发测试

   按需加载

按需加载

   全局:main.js

全局注册

重点 打包

   根目录下的package.json scripts 新增一个命令

"lib": "vue-cli-service build --target lib --name vue-aliplay-player --dest lib packages/vue-aliplay-player/index.js"
新增命令

打包后的效果查看

npm run lib

   会在根目录下多个lib文件


lib文件里面的内容

打包后测试调用

   按需加载

按需加载

   全局:main.js
全局注册

发布前调整

1、更改根目录的package.json 信息


package信息调整

2、.npmignore 过滤发布文件

.DS_Store
node_modules/
examples/
packages/
public/
vue.config.js
babel.config.js
*.map
*.html
 
# local env files
.env.local
.env.*.local
 
# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
 
# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw*

发布

注意: npm 源 一定要是 https://registry.npmjs.org/
查看源: npm config get registry
更改源: npm set registry https://registry.npmjs.org/

1、 npm login 
2、 npm publish

总结 【多实践多学习】

1、npm发布vue组件包不难,甚至都可不基于vue构建项目(项目构建只是为了方便调试、构建、管理), 只需如下结构


不是有vue项目构建

2、网上发布vue npm包的贴很多,但是大都是CV【真是坑爹】,或者是较老的用法还有就是没有讲到核心;
3、前端入门很快,进阶很难,别以为看了两篇教程就自以为功夫满级可以肉抗了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容