VUE插件开发及发布

前言

打算学习一下vue插件的开发和发布流程,查了许多教程,但是按照教程操作时还是遇到了许多问题,本篇博客就整理下插件开发过程以及注意事项。

一、初始化项目

vue init webpack-simple zseditor

使用vue创建一个简单的项目,删除src中除了main.js和app.vue外的文件,清空app.vue中无用内容,并在src目录下创建lib文件夹,整理后的项目目录如下:


项目目录

二、运行项目

cd zseditor
npm install
npm run dev

三、编写插件

1、在lib文件夹下新建两个文件,index.js以及zseditor.vue

插件目录

2、zseditor.vue
具体的组件代码就不写了

<template>
    <div>插件测试</div>
</template>
<script>
export default {
    name:'zseditor'
}
</script>

3、index.js

import zseditor from './zseditor'

const editor = {
  install(Vue, options) {
    Vue.component(zseditor.name, zseditor)
  }
}

if (typeof window !== 'undefined' && window.Vue) {
  window.Vue.use(editor);
}

export default editor

四、调试代码

main.js中引入组件,并在App.vue中填加组件测试
1、main.js

import zsEditor from './lib/index.js'
Vue.use(zsEditor)

2、App.vue

<template>
    <div id="app">
        <zs-editor></zs-editor>
    </div>
</template>

<script>
export default {
    name: "app"
}
</script>

五、发布插件

1、拷贝一份webpack.config.js,命名为webpack.dist.config.js,修改相关参数
许多教程中直接修改了webpack.config.js,导致'entry'入口被修改了,无法运行npm run dev进行本地调试,这里将打包配置分开,可以不影响本地的调试。

配置文件

webpack.dist.config.js

2、修改package.json配置文件
这里的main参数许多教程中并没有强调,需要配置成打包后的文件路径,不然会导致上传的插件,下载后无法引用

package.json

3、发布插件

npm login // 登录,没有账号要去npm官网注册
npm publish

六、下载测试

1、下载

npm install zseditor --save

2、在main.js中引用插件

import zseditor from 'zseditor'
Vue.use(zseditor)

3、在App.vue中添加组件

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

推荐阅读更多精彩内容