vue插件封装并发布npm流程记录

前言

我们平时可能使用vue + webpack开发过许多项目,有时候会需要特殊的插件或组件来满足我们的功能。比如日期插件,一般我们可以在网络上面找一个适合项目需求的控件。但是往往辛苦找到的控件不满足我们的需求,要么就改改改,要么我们可以自己做一个(当然前提是我们有足够的时间和兴趣)。既然我们的插件都做出来了,我们也可以将它发布到npm分享给更多的人使用,岂不是美事一桩。

步骤

下面将分成两个部分来讲解一下我自己在封装配置插件时研究的发布及更新流程,包括开发好的插件如何配置文件,以及如何发布npm并更新。这里只是介绍了自己配置插件或组件相关文件(并没有详细说明插件的开发过程),重点在于如何配置文件及发布npm。

1、封装vue插件

(1)初始化插件项目(命令:vue init webpack-simple vue-project-name),使用这个命令初始化的vue项目更适合封装vue插件,删除 src 中除了 main.js 和 app.vue 外的文件,清空 app.vue 中无用的内容,建议整理完项目目录如下:

初始化整理的项目目录

(2)使用vue+webpack开发好了一个插件(如:日期控件)或组件(如:像element-ui这种前端UI框架)。尝试在本地项目 app.vue 中引用刚刚完成插件,测试没问题之后再进行下一步。

(3)更改配置文件!!

        1、package.json文件:你的插件版本号,以后每次上传更新npm都需要修改;private 设置为 false 才能发布;mian 填写 dist 里文件路径;repository 如果你有github并上传了你的代码的话,填写你的github托管地址。修改如下图:

package.json文件配置修改

        2、对应插件(组件)目录下 index.js 文件,将插件(组件)对外暴露,如下:

向外暴露插件(组件)

        3、webpack.config.js 文件,修改 entry 和 filename,如下:

入口及文件名修改

        4、index.html 里 script src 路径修改,如下:

js应用路径修改

        5、gitignore 文件,去掉 dist/,如下:

去掉dist/

        6、在 src 目录下新建 index.js 文件,如下:

对外暴露插件(组件)

(4)运行命令 npm run build 就可以打包,然后按照接下来的步骤2发布到npm就可以了。

2、发布npm及更新

(1)安装 nodejs(网络上面教程很多)。

(2)根据步骤1开发并配置好了插件(组件)。

(3)去 npm 官网注册 npm 账号(官网:https://www.npmjs.com/)。

(4)进入你开发的插件(组件)项目目录,添加账户、登录、发布。

        1、上传发布之前,在 npm 官网搜索一下你的插件(组件)包名有没有被占用(即 package.json 里取名)。如被占用,修改取名 name 字段。

修改包名

        2、添加账户,登录,发布插件(添加账户是避免出现一些问题),如下图:

添加账户登录发布

(5)更新插件,在 package.json 里修改 version,小改动将最后一位加一,然后重复步骤(4),就实现了更新。

更新插件(组件)

以上就是vue插件(组件)封装并发布npm的步骤及注意事项的记录,希望对你能有所帮助。而我自己在以后的日子里,也可以翻阅出来巩固复习。

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