vue封裝第三方插件併發布到npm

時間 2019-11-16

原文原文鏈接

前言

寫此文前特地google了一下，由於有較詳細的開發教程我再寫意義不大，有把插件封裝成組件的教程，有把本身的組件封住成插件的教程，本文主要說明如何把第三方的插件封裝成vue插件，簡化配置，一鍵安裝，主要提供思路，封裝方法大同小異·，文章略長要有耐心。css

gitment

gitment是一個基於github issues封裝的評論插件，以這個插件做爲演示，把它封裝成vue插件。vue-gitment，該插件已發佈到npm,並在本身的開源項目vueblog中安裝使用html

項目初始化

封裝vue的插件用webpack-simple很合適，vue init webpack-simple vue-gitment此命令建立咱們的項目的目錄，建立文件夾和文件，最後結構是這樣的
前端

lib目錄是咱們的插件目錄，其餘的默認就好vue

修改配置項

首先是修改package.jsonwebpack

{
  "name": "vue-gitment",
  "version": "0.1.1",
  "description": "A comment plugin by gitment",
  "main": "dist/vue-gitment.js",
  "directories": {
    "dist": "dist"
  },
  "scripts": {
    "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
    "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/vue-blog/vue-gitment.git"
  },
  "dependencies": {
    "gitment": "^0.0.3",
    "vue": "^2.3.3"
  },
  "devDependencies": {
  },
  "author": "wmui",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/vue-blog/vue-gitment/issues"
  },
  "homepage": "https://github.com/vue-blog/vue-gitment#readme"
}

把依賴性gitment添加到dependencies，main是咱們打包後的文件入口，你能夠用npm init命令生成一個package.json
修改webpack.config.js

咱們只需配置入口和出口，不要刪除默認的配置，由於後面開發好插件，咱們須要查看工做效果
修改index.html

由於咱們修改了webpack配置，天然要把script的src修改一下git

封裝插件

VueComment.vue內容以下github

<template>
  <div v-comment="options"></div>
</template>
<script>
// 引入依賴項
import Gitment from 'gitment'
export default {
  name: 'vue-comment',
  props: ['options'],
  directives: {
    // 自定義指令
    comment: {
      bind: function (el, binding) {
        const gitment = new Gitment({
          id: binding.value.id + '',
          owner: binding.value.owner,
          repo: binding.value.repo,
          oauth: {
            client_id: binding.value.oauth.client_id,
            client_secret: binding.value.oauth.client_secret
          }
        })
        gitment.render(el)
      }
    }
  }
}
</script>

相信熟悉vue的一眼都看懂了，render函數是gitment對象的方法，不用關心，和咱們開發組件是同樣同樣的
index.js封裝組件web

import VueComment from './VueComment.vue'
const comment = {
  install: function(Vue) {
    Vue.component(VueComment.name, VueComment)
  }
}
// 這裏的判斷很重要
if (typeof window !== 'undefined' && window.Vue) { 
    window.Vue.use(comment) 
}
export default comment

咱們在webpack配置的入口文件就是他，install是掛載組件的方法，有了它咱們就能夠在外部use一個插件了，簡單吧npm

測試插件

首先測試build是否成功
npm run builddist目錄會生成以下文件

可喜可賀，接下來測試插件是否正常工做
咱們須要把package和webpack的修改一下，這就是爲何我前面說不要刪除而是註釋掉，把package.json的main修改成dist/build.js，wepack的entry和filename換成默認配置，index.html的src也換成默認的
在main.js中引入咱們的組件json

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

App.vue中使用咱們的插件

<template>
  <div id="app">
    <vue-comment :options="options" v-if="options"></vue-comment>
  </div>
</template>
<script>
export default {
  name: 'App',
  data() {
    return {
      options: {
        id: 'article id',
        owner: 'Your GitHub ID',
        repo: 'The repo to store comments',
        oauth: {
          client_id: 'Your client ID', 
          client_secret: 'Your client secret',
        } 
      }
    }
  }
}
</script>
<style>
    @import '~gitment/style/default.css';
</style>

執行npm run dev

哈哈，它正常工做了，Error: Not Found是由於我沒配置client_id。