使用Vue CLI 3將基於element-ui二次封裝的組件發佈到npm

時間 2019-11-08

標籤使用 vue cli 基於 element 二次封裝組件發佈 npm 欄目軟件設計简体版

原文原文鏈接

前言：以前在網上找的好多都是基於vue-cli 2.x的，而使用vue-cli 3的文章比較少，因此我在本身嘗試的時候把幾篇文章結合了一下，調出來了我想要的模式，也就是Vue CLI 3 + element-ui + 多個二次封裝的組件。最終想要的是 element-ui 這種感受的，不少組件能夠在不一樣項目中複用。

安裝依賴

首先用Vue CLI 3來初始化項目css

yarn global add @vue/cli
vue create qiyun-el-ui
vue ui

安裝element-ui

這裏使用官方提供的的插件安裝：
http://element.eleme.io/#/zh-...html

https://github.com/ElementUI/...vue

在插件列表搜索element

在這裏我選的手動導入，圖中是所有導入
node

這樣在項目中，就會新建一個plugins文件夾，裏面有個element.js 文件，若是想手動引入，就在這裏添加要依賴的組件，這裏是爲了調試組件：webpack

import Vue from 'vue'
import { 
  Button, 
  Dialog 
} from 'element-ui'

Vue.use(Button)
Vue.use(Dialog)

因爲咱們是基於element-ui的部分組件作的二次封裝，因此最好仍是按需引入所依賴的組件比較好。ios

編寫組件

在 src 的同級下面新建 packages 目錄，在這裏添加本身封裝的要發佈的組件。
例如，新建 qe-modal 文件夾，再接着新建 src 文件夾，裏面新建 qe-modal.vue，在這裏寫組件的代碼：git

<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 ，裏面註冊單獨的該組件，方便使用時能夠單獨引用：github

import qeModal from './src/qe-modal'

qeModal.install = function(Vue) {
  Vue.component(qeModal.name, qeModal)
}

export default qeModal

這樣一個組件就添加完成了，而後須要在 packages 的根目錄下添加一個總的 index.js，這裏是全局註冊的地方，使用時能夠全局引入，其實就跟 element-ui 的兩種方式同樣：web

import qeModal from './qe-modal'

const components = [
  qeModal
]

const install = function(Vue) {
  components.forEach(component => {
    Vue.component(component.name, component);
  });
}

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

export default {
  install,
  qeModal
}

後面再添加組件，在這裏也要再註冊一下，而element-ui 源碼中是動態引入的，咱們的項目組件還沒那麼多，能夠先一個個手動引入，若是後面數量多了，很差維護，能夠參考 element-ui 的源碼實現，我在這裏作了一些簡單的解釋。vue-cli

配置 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 <kuangshp@126.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"
  }
}