使用Vue CLI 3将基于element-ui二次封装的组件发布到npm

安装依赖

yarn global add @vue/cli

vue create qiyun-el-ui

vue ui

安装element-ui

这里使用官方提供的的插件安装:

http://element.eleme.io/#/zh-CN/component/quickstart#shi-yong-vue-cli-at-3

https://github.com/ElementUI/vue-cli-plugin-element


这样在项目中,就会新建一个plugins文件夹,里面有个element.js 文件,如果想手动引入,就在这里添加要依赖的组件,这里是为了调试组件:

importVuefrom'vue'

import{

Button,

Dialog

}from'element-ui'

Vue.use(Button)

Vue.use(Dialog)

由于我们是基于element-ui的部分组件做的二次封装,所以最好还是按需引入所依赖的组件比较好。

编写组件

在src的同级下面新建packages目录,在这里添加自己封装的要发布的组件。

例如,新建 qe-modal 文件夹,再接着新建 src 文件夹,里面新建 qe-modal.vue,在这里写组件的代码:

<template>

<el-dialog

:title="title"

:visible="dialogVisible"

@close="$emit('update:dialogVisible', false)"

:width="width">

<slot name="modal-body"></slot>

<div slot="footer" class="dialog-footer">

<slot name="modal-footer">

<el-button @click="$emit('update:dialogVisible', false)" size="small">取 消</el-button>

<el-button type="primary" @click="$emit('confirm')" size="small" :disabled="confirmDisable || beforeSendDisable">{{ beforeSendDisable? "处理中..." : "确 定" }}</el-button>

</slot>

</div>

</el-dialog>

</template>

<script>

export default {

name: 'qeModal',

props: {

dialogVisible: Boolean,

title: String,

width: {

type: String,

default: '580px'

},

beforeSendDisable: {

type: Boolean,

default: false

},

confirmDisable: {

type: Boolean,

default: false

}

}

}

</script>

在 qe-modal 根目录下新建 index.js ,里面注册单独的该组件,方便使用时可以单独引用:

importqeModalfrom'./src/qe-modal'

qeModal.install =function(Vue){

Vue.component(qeModal.name, qeModal)

}

exportdefaultqeModal

这样一个组件就添加完成了,然后需要在 packages 的根目录下添加一个总的 index.js,这里是全局注册的地方,使用时可以全局引入,其实就跟 element-ui 的两种方式一样:

importqeModalfrom'./qe-modal'

constcomponents = [

qeModal

]

constinstall =function(Vue){

components.forEach(component=>{

Vue.component(component.name, component);

});

}

if(typeofwindow!=='undefined'&&window.Vue) {

install(window.Vue);

}

exportdefault{

install,

qeModal

}

后面再添加组件,在这里也要再注册一下,而element-ui 源码中是动态引入的,我们的项目组件还没那么多,可以先一个个手动引入,如果后面数量多了,不好维护,可以参考 element-ui 的源码实现,我在这里做了一些简单的解释。

配置 npm

在 package.json 里面的 script 里面加一个 lib选项,方便每次构建:

"scripts": {

// ...,

"lib":"vue-cli-service build --target lib --name qiyun-el-ui --dest lib ./packages/index.js"

},

其中 --name 后面是你最后想要生成文件的名字,并用 --dest lib 修改了构建的目录。

然后在 package.json 里面添加一些npm包发布的相关信息,比如作者、版本等:

其中最重要的是:

"main": "lib/qiyun-el-ui.common.js",

这里的路径要和上面构建出来的目录和文件名对应上。

里面的配置项,在网上找了个例子:

{

"name":"maucash",

"description":"maucash中常用组件抽取",

"version":"1.0.2",

"author":"kuangshp <dmcdodo@163.com>",

// 开源协议

"license":"MIT",

// 因为组件包是公用的,所以private为false

"private":false,

// 配置main结点,如果不配置,我们在其他项目中就不用import XX from '包名'来引用了,只能以包名作为起点来指定相对的路径

"main":"dist/maucash.js",

"scripts": {

"dev":"cross-env NODE_ENV=development webpack-dev-server --open --hot",

"build":"cross-env NODE_ENV=production webpack --progress --hide-modules"

},

"dependencies": {

"axios":"^0.18.0",

"iview":"^2.14.1",

"style-loader":"^0.23.1",

"url-loader":"^1.1.2",

"vue":"^2.5.11"

},

// 指定代码所在的仓库地址

"repository": {

"type":"git",

"url":"git+git@git.wolaidai.com:maucash/maucash.git"

},

// 指定打包后,包中存在的文件夹

"files": [

"dist",

"src"

],

// 指定关键词

"keywords": [

"vue",

"maucash",

"code",

"maucash code"

],

// 项目官网的地址

"homepage":"https://github.com/kuangshp/maucash",

"browserslist": [

"> 1%",

"last 2 versions",

"not ie <= 8"

],

"devDependencies": {

"babel-core":"^6.26.0",

"babel-loader":"^7.1.2",

"babel-plugin-transform-runtime":"^6.23.0",

"babel-preset-env":"^1.6.0",

"babel-preset-stage-3":"^6.24.1",

"cross-env":"^5.0.5",

"css-loader":"^0.28.7",

"file-loader":"^1.1.4",

"node-sass":"^4.5.3",

"sass-loader":"^6.0.6",

"vue-loader":"^13.0.5",

"vue-template-compiler":"^2.4.4",

"webpack":"^3.6.0",

"webpack-dev-server":"^2.9.1"

}

}

发布到npm

到这块后面的网上有很多更细致的教程,我就不在这里赘述了。下面给出两个文章的链接,供参考。

1、到npm上注册一个账号

2、登录

npm login

3、添加用户信息

npm adduser

4、发布到远程仓库(npm)上

npm publish

5、删除远程仓库的包

npx force-unpublish package-name '原因描述'

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