[Vue CLI 3] vue inspect 的源碼設計實現

首先，請記住：

它在新版本的腳手架項目裏面很是重要

它有什麼用呢？

inspect internal webpack config

能快速地在控制檯看到對應生成的 webpack 配置對象。

首先它是 vue 的一個擴展命令，在文件 @vue/cli/bin/vue.js 中定義了 command

仍是依賴了工具包 commander

const program = require('commander')

代碼配置以下：

program
  .command('inspect [paths...]')
  .description('inspect the webpack config in a project with vue-cli-service')
  .option('--mode <mode>')
  .option('--rule <ruleName>', 'inspect a specific module rule')
  .option('--plugin <pluginName>', 'inspect a specific plugin')
  .option('--rules', 'list all module rule names')
  .option('--plugins', 'list all plugin names')
  .option('-v --verbose', 'Show full function definitions in output')
  .action((paths, cmd) => {
    require('../lib/inspect')(paths, cleanArgs(cmd))
  })

這裏的 option 比較多：

• mode
• rule
• plugin
• rules
• plugins
• verbose

在前面的文章中，咱們比較經常使用的有 rule 相關的

再接着看一下 lib/inspect.js 文件：接受 2 個參數：

• paths
• args

module.exports = function inspect (paths, args) {
}

核心仍是找到 @vue/cli-service，先獲取當前執行命令的目錄：

const cwd = process.cwd()

let servicePath = resolve.sync('@vue/cli-service', { basedir: cwd })

最終執行了 node ***/node_modules/@vue/cli-service/bin/vue-cli-service.js inspect 再帶上參數：

調用了工具包 execa：

const execa = require('execa')

execa('node', [
  binPath,
  'inspect',
  ...(args.mode ? ['--mode', args.mode] : []),
  ...(args.rule ? ['--rule', args.rule] : []),
  ...(args.plugin ? ['--plugin', args.plugin] : []),
  ...(args.rules ? ['--rules'] : []),
  ...(args.plugins ? ['--plugins'] : []),
  ...(args.verbose ? ['--verbose'] : []),
  ...paths
], { cwd, stdio: 'inherit' })

那咱們接着往下看，後面就是去 cli-service 目錄了：@vue/cli-service/lib/commands/inspect.js

經過 api.registerCommand 來註冊一個:

module.exports = (api, options) => {
  api.registerCommand('inspect', {

  }, args => {

  })
}

在回調函數裏面會處理以前的 option 傳遞的參數：

一、處理 rule

if (args.rule) {
  res = config.module.rules.find(r => r.__ruleNames[0] === args.rule)
}

二、處理 plugin

if (args.plugin) {
  res = config.plugins.find(p => p.__pluginName === args.plugin)
}

三、處理 rules

if (args.rules) {
  res = config.module.rules.map(r => r.__ruleNames[0])
}

四、處理 plugins

if (args.plugins) {
  res = config.plugins.map(p => p.__pluginName || p.constructor.name)
}

其餘分支狀況比較少用，暫時不作展開。

最後可能是經過 webpack-chain 的 toString 函數來生成，最終在控制檯打印：

You can inspect the generated webpack config using config.toString(). This will generate a stringified version of the config with comment hints for named rules, uses and plugins.

const { toString } = require('webpack-chain')
const output = toString(res, { verbose })