快捷導(dǎo)航

vue封裝第三方插件并發(fā)布到npm的方法

更新時(shí)間：2017年09月25日 14:59:43 作者：wmui

本篇文章主要介紹了vue封裝第三方插件并發(fā)布到npm的方法，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

前言

寫此文前特意google了一下，因?yàn)橛休^詳細(xì)的開發(fā)教程我再寫意義不大，有把插件封裝成組件的教程，有把自己的組件封住成插件的教程，本文主要說(shuō)明如何把第三方的插件封裝成vue插件，簡(jiǎn)化配置，一鍵安裝，主要提供思路，封裝方法大同小異·，文章略長(zhǎng)要有耐心。

gitment

gitment是一個(gè)基于github issues封裝的評(píng)論插件，以這個(gè)插件作為演示，把它封裝成vue插件。vue-gitment，該插件已發(fā)布到npm,并在自己的開源項(xiàng)目vueblog中安裝使用

項(xiàng)目初始化

封裝vue的插件用webpack-simple很合適，vue init webpack-simple vue-gitment此命令創(chuàng)建我們的項(xiàng)目的目錄，創(chuàng)建文件夾和文件，最后結(jié)構(gòu)是這樣的

lib目錄是我們的插件目錄，其他的默認(rèn)就好

修改配置項(xiàng)

首先是修改package.json

{
 "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命令生成一個(gè)package.json

修改webpack.config.js

我們只需配置入口和出口，不要?jiǎng)h除默認(rèn)的配置，因?yàn)楹竺骈_發(fā)好插件，我們需要查看工作效果

修改index.html

因?yàn)槲覀冃薷牧藈ebpack配置，自然要把script的src修改一下

封裝插件

VueComment.vue內(nèi)容如下

<template>
 <div v-comment="options"></div>
</template>
<script>
// 引入依賴項(xiàng)
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函數(shù)是gitment對(duì)象的方法，不用關(guān)心，和我們開發(fā)組件是一樣一樣的

index.js封裝組件

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

我們?cè)趙ebpack配置的入口文件就是他，install是掛載組件的方法，有了它我們就可以在外部use一個(gè)插件了，簡(jiǎn)單吧

測(cè)試插件

首先測(cè)試build是否成功

npm run builddist目錄會(huì)生成如下文件

可喜可賀，接下來(lái)測(cè)試插件是否正常工作

我們需要把package和webpack的修改一下，這就是為什么我前面說(shuō)不要?jiǎng)h除而是注釋掉，把package.json的main修改為dist/build.js，wepack的entry和filename換成默認(rèn)配置，index.html的src也換成默認(rèn)的

在main.js中引入我們的組件

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>

執(zhí)行npm run dev

哈哈，它正常工作了，Error: Not Found是因?yàn)槲覜](méi)配置client_id。

發(fā)布插件

完成測(cè)試工作后我們就可以發(fā)布到npm了，這個(gè)就比較見到了，注冊(cè)個(gè)npm賬號(hào)，在你要發(fā)布的項(xiàng)目目錄執(zhí)行npm login，輸入賬號(hào)密碼和郵箱，然后npm publish就發(fā)布成功了，npm install vue-gitment查看效果，建議直接看源代碼，因?yàn)檎娴暮芎?jiǎn)單。

結(jié)語(yǔ)

自己動(dòng)手豐衣足食，我覺(jué)得每個(gè)前端開發(fā)者都要一個(gè)屬于自己的輪子(雖然vue-gitment不是輪子)，一個(gè)屬于自己輪子，在造輪子的工程中你能學(xué)到很多很多

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: