[Vue CLI 3] 插件編寫實戰(zhàn)和源碼分析

當(dāng)你看過了官方的幾個插件之后暇仲,慢慢地久妆,其實你也有需求了缩麸。

那如何編寫一個 Vue CLI 3 的插件呢窒升?

本文代碼已經(jīng)放到 github 上缀遍,地址:https://github.com/dailynodejs/vue-cli-plugin-demo


我們建一個文件夾,取名 vue-cli-plugin-demo饱须,創(chuàng)建一個 index.js

module.exports = (api, projectOptions) => {
  //...
}

因為我們看遍了 cli-plugin-babel域醇、cli-plugin-eslint 等,我們發(fā)現(xiàn)他們的最外層結(jié)構(gòu)多是類似的:

多有一個 index.js

接受 2 個參數(shù):

  • api
  • options
module.exports = (api, options) => {
  // ...
}

里面就是插件的核心部分蓉媳,我們觀察到它們兩個也很類似譬挚,多用到了:

api.chainWebpack(webpackConfig => {
  // ...
})

但同時在 eslint 的源碼中,我們看到了:

api.registerCommand('lint', {
}, args => {
  // ...
})

我們看項目根目錄的 package.json 有一個命令

"scripts": {
  "lint": "vue-cli-service lint"
}

所以看起來:api.registerCommand 就是可以注冊命令的酪呻。

大家還記得我們還有其他之前介紹過的命令嗎:

"scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build"
}

我們看一下它們是不是也是這樣注冊的:

@vue/cli-service/lib/commands/build/

module.exports = (api, options) => {
  api.registerCommand('build', {
  }, async (args) => {
  })
}

cli-service/lib/commands/serve.js

module.exports = (api, options) => {
  api.registerCommand('serve', {
  }, async function serve (args) {
  })
}

那我們的 demo 也注冊一個命令:

module.exports = (api, projectOptions) => {
  api.registerCommand('demo', {
    description: 'demo plugin for vue cli 3',
    usage: 'vue-cli-service demo',
    options: {}
  }, (args) => {
    let options = projectOptions.pluginOptions.demoOptions
    console.log('options', options)
  })
}

這里要提到 vue.config.js 里面的一個配置項了 pluginOptions

它可以用來給第三方插件傳遞配置

所以我們正好可以通過它進行一些配置:

module.exports = {
  pluginOptions: {
    demoOptions: {
      c: 1,
      d: 2
    }
  }
}

然后在插件里面獲取的方式就是上面的代碼中:

let options = projectOptions.pluginOptions.demoOptions
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末殴瘦,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子号杠,更是在濱河造成了極大的恐慌蚪腋,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,376評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件姨蟋,死亡現(xiàn)場離奇詭異屉凯,居然都是意外死亡,警方通過查閱死者的電腦和手機眼溶,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,126評論 2 385
  • 文/潘曉璐 我一進店門悠砚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人堂飞,你說我怎么就攤上這事灌旧。” “怎么了绰筛?”我有些...
    開封第一講書人閱讀 156,966評論 0 347
  • 文/不壞的土叔 我叫張陵枢泰,是天一觀的道長。 經(jīng)常有香客問我铝噩,道長衡蚂,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,432評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮毛甲,結(jié)果婚禮上年叮,老公的妹妹穿的比我還像新娘。我一直安慰自己玻募,他們只是感情好只损,可當(dāng)我...
    茶點故事閱讀 65,519評論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著七咧,像睡著了一般跃惫。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上坑雅,一...
    開封第一講書人閱讀 49,792評論 1 290
  • 那天辈挂,我揣著相機與錄音衬横,去河邊找鬼裹粤。 笑死,一個胖子當(dāng)著我的面吹牛蜂林,可吹牛的內(nèi)容都是我干的遥诉。 我是一名探鬼主播,決...
    沈念sama閱讀 38,933評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼噪叙,長吁一口氣:“原來是場噩夢啊……” “哼矮锈!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起睁蕾,我...
    開封第一講書人閱讀 37,701評論 0 266
  • 序言:老撾萬榮一對情侶失蹤苞笨,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后子眶,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體瀑凝,經(jīng)...
    沈念sama閱讀 44,143評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,488評論 2 327
  • 正文 我和宋清朗相戀三年臭杰,在試婚紗的時候發(fā)現(xiàn)自己被綠了粤咪。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,626評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡渴杆,死狀恐怖寥枝,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情磁奖,我是刑警寧澤囊拜,帶...
    沈念sama閱讀 34,292評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站比搭,受9級特大地震影響艾疟,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,896評論 3 313
  • 文/蒙蒙 一蔽莱、第九天 我趴在偏房一處隱蔽的房頂上張望弟疆。 院中可真熱鬧,春花似錦盗冷、人聲如沸怠苔。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,742評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽柑司。三九已至,卻和暖如春锅劝,著一層夾襖步出監(jiān)牢的瞬間攒驰,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工故爵, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留玻粪,地道東北人。 一個月前我還...
    沈念sama閱讀 46,324評論 2 360
  • 正文 我出身青樓诬垂,卻偏偏與公主長得像劲室,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子结窘,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,494評論 2 348

推薦閱讀更多精彩內(nèi)容