分析vue-cli@2.9.3 搭建的webpack項目工程

前言

已經有不少分析Vue-cli搭建工程的文章，爲何本身還要寫一遍呢。學習就比如是座大山，人們沿着不一樣的路爬山，分享着本身看到的風景。你不必定能看到別人看到的風景，體會到別人的心情。只有本身去爬山，才能看到不同的風景，體會才更加深入。

項目放在筆者的github上，分析vue-cli@2.9.3 搭建的webpack項目工程。方便你們克隆下載，或者在線查看。同時也求個star ^_^，也是對筆者的一種鼓勵和支持。

正文從這裏開始～

使用vue-cli初始化webpack工程

// # 安裝
npm install -g vue-cli
// 安裝完後vue命令就可使用了。其實是全局註冊了vue、vue-init、vue-list幾個命令

// # ubuntu 系統下
// [vue-cli@2.9.3] link /usr/local/bin/vue@ -> /usr/local/lib/node_modules/vue-cli/bin/vue
// [vue-cli@2.9.3] link /usr/local/bin/vue-init@ -> /usr/local/lib/node_modules/vue-cli/bin/vue-init
// [vue-cli@2.9.3] link /usr/local/bin/vue-list@ -> /usr/local/lib/node_modules/vue-cli/bin/vue-list

vue list
// 能夠發現有browserify、browserify-simple、pwa、simple、webpack、webpack-simple幾種模板可選，這裏選用webpack。

// # 使用 vue init
vue init <template-name> <project-name>

// # 例子
vue init webpack analyse-vue-cli
複製代碼

更多vue-cli如何工做的能夠查看這篇文章vue-cli是如何工做的，或者分析Vue-cli源碼查看這篇走進Vue-cli源碼，本身動手搭建前端腳手架工具，再或者直接查看vue-cli github倉庫源碼

若是對webpack還不是很瞭解，能夠查看webpack官方文檔中的概念，雖然是最新版本的，但概念都是差很少的。

package.json

分析一個項目，通常從package.json的命令入口scripts開始。

"scripts": {
  // dev webpack-dev-server --inline 模式 --progress 顯示進度 --config 指定配置文件（默認是webpack.config.js）
  "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
  "start": "npm run dev",
  // jest測試
  "unit": "jest --config test/unit/jest.conf.js --coverage",
  // e2e測試
  "e2e": "node test/e2e/runner.js",
  // 運行jest測試和e2e測試
  "test": "npm run unit && npm run e2e",
  // eslint --ext 指定擴展名和相應的文件
  "lint": "eslint --ext .js,.vue src test/unit test/e2e/specs",
  // node 執行build/build.js文件
  "build": "node build/build.js"
},
複製代碼

Npm Script 底層實現原理是經過調用 Shell 去運行腳本命令。npm run start等同於運行npm run dev。

Npm Script 還有一個重要的功能是能運行安裝到項目目錄裏的 node_modules 裏的可執行模塊。

例如在經過命令npm i -D webpack-dev-server將webpack-dev-server安裝到項目後，是沒法直接在項目根目錄下經過命令 webpack-dev-server 去執行 webpack-dev-server 構建的，而是要經過命令 ./node_modules/.bin/webpack-dev-server 去執行。

Npm Script 能方便的解決這個問題，只須要在 scripts 字段裏定義一個任務，例如：

"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js"
複製代碼

Npm Script 會先去項目目錄下的 node_modules 中尋找有沒有可執行的 webpack-dev-server 文件，若是有就使用本地的，若是沒有就使用全局的。 因此如今執行 webpack-dev-server 啓動服務時只須要經過執行 npm run dev 去實現。

再來看下 npm run dev webpack-dev-server 實際上是一個node.js的應用程序，它是經過JavaScript開發的。在命令行執行npm run dev命令等同於執行node ./node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --progress --config build/webpack.dev.conf.js。你能夠試試。

更多package.json的配置項，能夠查看阮一峯老師的文章 package.json文件

npm run dev指定了build/webpack.dev.conf.js配置去啓動服務，那麼咱們來看下這個文件作了什麼。

build/webpack.dev.conf.js webpack開發環境配置

這個文件主要作了如下幾件事情：
一、引入各類依賴，同時也引入了config文件夾下的變量和配置，和一個工具函數build/utils.js，
二、合併build/webpack.base.conf.js配置文件，
三、配置開發環境一些devServer，plugin等配置，
四、最後導出了一個Promise，根據配置的端口，尋找可用的端口來啓動服務。

具體能夠看build/webpack.dev.conf.js這個文件註釋：

'use strict'
// 引入工具函數
const utils = require('./utils')
// 引入webpack
const webpack = require('webpack')
// 引入config/index.js配置
const config = require('../config')
// 合併webpack配置
const merge = require('webpack-merge')
const path = require('path')
// 基本配置
const baseWebpackConfig = require('./webpack.base.conf')
// 拷貝插件
const CopyWebpackPlugin = require('copy-webpack-plugin')
// 生成html的插件
const HtmlWebpackPlugin = require('html-webpack-plugin')
// 友好提示的插件 https://github.com/geowarin/friendly-errors-webpack-plugin
const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin')
// 查找可用端口 // github倉庫 https://github.com/indexzero/node-portfinder
const portfinder = require('portfinder')


// process模塊用來與當前進程互動，能夠經過全局變量process訪問，沒必要使用require命令加載。它是一個EventEmitter對象的實例。

// 後面有些process模塊用到的，因此這裏統一列舉下。
// 更多查看這篇阮一峯的這篇文章 http://javascript.ruanyifeng.com/nodejs/process.html

// process對象提供一系列屬性，用於返回系統信息。
// process.pid：當前進程的進程號。
// process.version：Node的版本，好比v0.10.18。
// process.platform：當前系統平臺，好比Linux。
// process.title：默認值爲「node」，能夠自定義該值。
// process.argv：當前進程的命令行參數數組。
// process.env：指向當前shell的環境變量，好比process.env.HOME。
// process.execPath：運行當前進程的可執行文件的絕對路徑。
// process.stdout：指向標準輸出。
// process.stdin：指向標準輸入。
// process.stderr：指向標準錯誤。

// process對象提供如下方法：
// process.exit()：退出當前進程。
// process.cwd()：返回運行當前腳本的工做目錄的路徑。_
// process.chdir()：改變工做目錄。
// process.nextTick()：將一個回調函數放在下次事件循環的頂部。

// host
const HOST = process.env.HOST
// 端口
const PORT = process.env.PORT && Number(process.env.PORT)

// 合併基本的webpack配置
const devWebpackConfig = merge(baseWebpackConfig, {
  module: {
    // cssSourceMap這裏配置的是true
    rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap, usePostCSS: true })
  },
  // cheap-module-eval-source-map is faster for development
  // 在開發環境是cheap-module-eval-source-map選項更快
  // 這裏配置的是cheap-module-eval-source-map
  // 更多能夠查看中文文檔：https://webpack.docschina.org/configuration/devtool/#devtool
  // 英文 https://webpack.js.org/configuration/devtool/#development
  devtool: config.dev.devtool,

  // these devServer options should be customized in /config/index.js
  devServer: {
    // 配置在客戶端的日誌等級，這會影響到你在瀏覽器開發者工具控制檯裏看到的日誌內容。
    // clientLogLevel 是枚舉類型，可取以下之一的值 none | error | warning | info。
    // 默認爲 info 級別，即輸出全部類型的日誌，設置成 none 能夠不輸出任何日誌。
    clientLogLevel: 'warning',
    // historyApiFallback boolean object 用於方便的開發使用了 HTML5 History API 的單頁應用。
    // 能夠簡單true 或者 任意的 404 響應能夠提供爲 index.html 頁面。
    historyApiFallback: {
      rewrites: [
        // config.dev.assetsPublicPath 這裏是 /
        { from: /.*/, to: path.posix.join(config.dev.assetsPublicPath, 'index.html') },
      ],
    },
    // 開啓熱更新
    hot: true,
    // contentBase 配置 DevServer HTTP 服務器的文件根目錄。
    // 默認狀況下爲當前執行目錄，一般是項目根目錄，全部通常狀況下你沒必要設置它，除非你有額外的文件須要被 DevServer 服務。
    contentBase: false, // since we use CopyWebpackPlugin.
    // compress 配置是否啓用 gzip 壓縮。boolean 爲類型，默認爲 false。
    compress: true,
    // host
    // 例如你想要局域網中的其它設備訪問你本地的服務，能夠在啓動 DevServer 時帶上 --host 0.0.0.0
    // 或者直接設置爲 0.0.0.0
    // 這裏配置的是localhost
    host: HOST || config.dev.host,
    // 端口號 這裏配置的是8080
    port: PORT || config.dev.port,
    // 打開瀏覽器，這裏配置是不打開false
    open: config.dev.autoOpenBrowser,
    // 是否在瀏覽器以遮罩形式顯示報錯信息 這裏配置的是true
    overlay: config.dev.errorOverlay
      ? { warnings: false, errors: true }
      : false,
      // 這裏配置的是 /
    publicPath: config.dev.assetsPublicPath,
    // 代理 這裏配置的是空{},有須要能夠自行配置
    proxy: config.dev.proxyTable,
    // 啓用 quiet 後，除了初始啓動信息以外的任何內容都不會被打印到控制檯。這也意味着來自 webpack 的錯誤或警告在控制檯不可見。
    // 開啓後通常很是乾淨只有相似的提示 Your application is running here: http://localhost:8080
    quiet: true, // necessary for FriendlyErrorsPlugin
    // webpack-dev-middleware
    // watch: false,
    // 啓用 Watch 模式。這意味着在初始構建以後，webpack 將繼續監放任何已解析文件的更改。Watch 模式默認關閉。
    // webpack-dev-server 和 webpack-dev-middleware 裏 Watch 模式默認開啓。
    // Watch 模式的選項
    watchOptions: {
      // 或者指定毫秒爲單位進行輪詢。
      // 這裏配置爲false
      poll: config.dev.poll,
    }
    // 更多查看中文文檔：https://webpack.docschina.org/configuration/watch/#src/components/Sidebar/Sidebar.jsx
  },
  plugins: [
    // 定義爲開發環境
    new webpack.DefinePlugin({
      // 這裏是 { NODE_ENV: '"development"' }
      'process.env': require('../config/dev.env')
    }),
    // 熱更新插件
    new webpack.HotModuleReplacementPlugin(),
    // 熱更新時顯示具體的模塊路徑
    new webpack.NamedModulesPlugin(), // HMR shows correct file names in console on update.
    // 在編譯出現錯誤時，使用 NoEmitOnErrorsPlugin 來跳過輸出階段。
    new webpack.NoEmitOnErrorsPlugin(),
    // github倉庫 https://github.com/ampedandwired/html-webpack-plugin
    new HtmlWebpackPlugin({
      filename: 'index.html',
      template: 'index.html',
      // inject 默認值 true，script標籤位於html文件的 body 底部
      // body 通true, header, script 標籤位於 head 標籤內
      // false 不插入生成的 js 文件，只是單純的生成一個 html 文件
      inject: true
    }),
    // copy custom static assets
    // 把static資源複製到相應目錄。
    new CopyWebpackPlugin([
      {
        // 這裏是 static
        from: path.resolve(__dirname, '../static'),
        // 這裏是 static
        to: config.dev.assetsSubDirectory,
        // 忽略.開頭的文件。好比這裏的.gitkeep，這個文件是指空文件夾也提交到git
        ignore: ['.*']
      }
    ])
  ]
})
// 導出一個promise
module.exports = new Promise((resolve, reject) => {
  // process.env.PORT 能夠在命令行指定端口號，好比PORT=2000 npm run dev，那訪問就是http://localhost:2000
  // config.dev.port 這裏配置是 8080
  portfinder.basePort = process.env.PORT || config.dev.port
  // 以配置的端口爲基準，尋找可用的端口，好比：若是8080佔用，那就8081,以此類推
  // github倉庫 https://github.com/indexzero/node-portfinder
  portfinder.getPort((err, port) => {
    if (err) {
      reject(err)
    } else {
      // publish the new Port, necessary for e2e tests
      process.env.PORT = port
      // add port to devServer config
      devWebpackConfig.devServer.port = port

      // Add FriendlyErrorsPlugin
      devWebpackConfig.plugins.push(new FriendlyErrorsPlugin({
        compilationSuccessInfo: {
          messages: [`Your application is running here: http://${devWebpackConfig.devServer.host}:${port}`],
        },
        // notifyOnErrors 這裏配置是 true
        // onErrors 是一個函數，出錯輸出錯誤信息，系統原生的通知
        onErrors: config.dev.notifyOnErrors
        ? utils.createNotifierCallback()
        : undefined
      }))

      resolve(devWebpackConfig)
    }
  })
})
複製代碼

build/utils.js 工具函數

上文build/webpack.dev.conf.js提到引入了build/utils.js工具函數。
該文件主要寫了如下幾個工具函數：
一、assetsPath返回輸出路徑，
二、cssLoaders返回相應的css-loader配置，
三、styleLoaders返回相應的處理樣式的配置，
四、createNotifierCallback建立啓動服務時出錯時提示信息回調。

具體配置能夠看該文件註釋：

'use strict'
const path = require('path')
// 引入配置文件config/index.js
const config = require('../config')
// 提取css的插件
const ExtractTextPlugin = require('extract-text-webpack-plugin')
// 引入package.json配置
const packageConfig = require('../package.json')
// 返回路徑
exports.assetsPath = function (_path) {
  const assetsSubDirectory = process.env.NODE_ENV === 'production'
    // 二級目錄 這裏是 static
    ? config.build.assetsSubDirectory
    // 二級目錄 這裏是 static
    : config.dev.assetsSubDirectory

  // 生成跨平臺兼容的路徑
  // 更多查看Node API連接：https://nodejs.org/api/path.html#path_path_posix
  return path.posix.join(assetsSubDirectory, _path)
}

exports.cssLoaders = function (options) {
  // 做爲參數傳遞進來的options對象
  // {
  //   // sourceMap這裏是true
  //   sourceMap: true,
  //   // 是否提取css到單獨的css文件
  //   extract: true,
  //   // 是否使用postcss
  //   usePostCSS: true
  // }
  options = options || {}

  const cssLoader = {
    loader: 'css-loader',
    options: {
      sourceMap: options.sourceMap
    }
  }

  const postcssLoader = {
    loader: 'postcss-loader',
    options: {
      sourceMap: options.sourceMap
    }
  }

  // generate loader string to be used with extract text plugin
  // 建立對應的loader配置
  function generateLoaders (loader, loaderOptions) {
    // 是否使用usePostCSS，來決定是否採用postcssLoader
    const loaders = options.usePostCSS ? [cssLoader, postcssLoader] : [cssLoader]

    if (loader) {
      loaders.push({
        loader: loader + '-loader',
        // 合併 loaderOptions 生成options
        options: Object.assign({}, loaderOptions, {
          sourceMap: options.sourceMap
        })
      })
    }

    // Extract CSS when that option is specified
    // (which is the case during production build)
    if (options.extract) {
      // 若是提取使用ExtractTextPlugin插件提取
      // 更多配置 看插件中文文檔：https://webpack.docschina.org/plugins/extract-text-webpack-plugin/
      return ExtractTextPlugin.extract({
        // 指須要什麼樣的loader去編譯文件
        // loader 被用於將資源轉換成一個 CSS 導出模塊 (必填)
        use: loaders,
        // loader（例如 'style-loader'）應用於當 CSS 沒有被提取(也就是一個額外的 chunk，當 allChunks: false)
        fallback: 'vue-style-loader'
      })
    } else {
      return ['vue-style-loader'].concat(loaders)
    }
  }

  // https://vue-loader.vuejs.org/en/configurations/extract-css.html
  return {
    css: generateLoaders(),
    postcss: generateLoaders(),
    less: generateLoaders('less'),
    // sass indentedSyntax 語法縮進，相似下方格式
    // #main
    //   color: blue
    //   font-size: 0.3em
    sass: generateLoaders('sass', { indentedSyntax: true }),
    scss: generateLoaders('sass'),
    stylus: generateLoaders('stylus'),
    styl: generateLoaders('stylus')
  }
}

// Generate loaders for standalone style files (outside of .vue)
// 最終會返回webpack css相關的配置
exports.styleLoaders = function (options) {
  // {
  //   // sourceMap這裏是true
  //   sourceMap: true,
  //   // 是否提取css到單獨的css文件
  //   extract: true,
  //   // 是否使用postcss
  //   usePostCSS: true
  // }
  const output = []
  const loaders = exports.cssLoaders(options)

  for (const extension in loaders) {
    const loader = loaders[extension]
    output.push({
      test: new RegExp('\\.' + extension + '$'),
      use: loader
    })
  }

  return output
}

// npm run dev 出錯時， FriendlyErrorsPlugin插件 配置 onErrors輸出錯誤信息
exports.createNotifierCallback = () => {
  // 'node-notifier'是一個跨平臺系統通知的頁面，當遇到錯誤時，它能用系統原生的推送方式給你推送信息
  const notifier = require('node-notifier')

  return (severity, errors) => {
    if (severity !== 'error') return

    const error = errors[0]
    const filename = error.file && error.file.split('!').pop()

    notifier.notify({
      title: packageConfig.name,
      message: severity + ': ' + error.name,
      subtitle: filename || '',
      icon: path.join(__dirname, 'logo.png')
    })
  }
}

複製代碼

build/webpack.base.conf.js webpack基本配置文件

上文build/webpack.dev.conf.js提到引入了build/webpack.base.conf.js這個webpack基本配置文件。
這個文件主要作了如下幾件事情：
一、引入各類插件、配置等，其中引入了build/vue-loader.conf.js相關配置，
二、建立eslint規則配置，默認啓用，
三、導出webpack配置對象，其中包含context，入口entry，輸出output，resolve，module下的rules（處理對應文件的規則），和node相關的配置等。

具體能夠看這個文件註釋：

// 使用嚴格模式，更多嚴格模式能夠查看
// [阮一峯老師的es標準入門](http://es6.ruanyifeng.com/?search=%E4%B8%A5%E6%A0%BC%E6%A8%A1%E5%BC%8F&x=0&y=0#docs/function#%E4%B8%A5%E6%A0%BC%E6%A8%A1%E5%BC%8F)
'use strict'
const path = require('path')
// 引入工具函數
const utils = require('./utils')
// 引入配置文件，也就是config/index.js文件
const config = require('../config')
// 引入vue-loader的配置文件
const vueLoaderConfig = require('./vue-loader.conf')
// 定義獲取絕對路徑函數
function resolve (dir) {
  return path.join(__dirname, '..', dir)
}
// 建立eslint配置
const createLintingRule = () => ({
  test: /\.(js|vue)$/,
  loader: 'eslint-loader',
  // 執行順序，前置，還有一個選項是post是後置
  // 把 eslint-loader 的執行順序放到最前面，防止其它 Loader 把處理後的代碼交給 eslint-loader 去檢查
  enforce: 'pre',
  // 包含文件夾
  include: [resolve('src'), resolve('test')],
  options: {
    // 使用友好的eslint提示插件
    formatter: require('eslint-friendly-formatter'),
    // eslint報錯提示是否顯示以遮罩形式顯示在瀏覽器中
    // 這裏showEslintErrorsInOverlay配置是false
    emitWarning: !config.dev.showEslintErrorsInOverlay
  }
})

module.exports = {
  // 運行環境的上下文，就是實際的目錄，也就是項目根目錄
  context: path.resolve(__dirname, '../'),
  // 入口
  entry: {
    app: './src/main.js'
  },
  // 輸出
  output: {
    // 路徑 這裏是根目錄下的dist
    path: config.build.assetsRoot,
    // 文件名
    filename: '[name].js',
    publicPath: process.env.NODE_ENV === 'production'
      // 這裏是 /，但要上傳到github pages等會路徑不對，須要修改成./
      ? config.build.assetsPublicPath
      // 這裏配置是 /
      : config.dev.assetsPublicPath
  },
  // Webpack 在啓動後會從配置的入口模塊出發找出全部依賴的模塊，Resolve 配置 Webpack 如何尋找模塊所對應的文件。
  resolve: {
    // 配置了這個，對應的擴展名能夠省略
    extensions: ['.js', '.vue', '.json'],
    alias: {
      // 給定對象的鍵後的末尾添加 $，以表示精準匹配 node_modules/vue/dist/vue.esm.js
      // 引用 import Vue from 'vue'就是引入的這個文件最後export default Vue 導出的Vue;
      // 因此這句能夠以任意大寫字母命名 好比：import V from 'vue'
      'vue$': 'vue/dist/vue.esm.js',
      // src別名 好比 ：引入import HelloWorld from '@/components/HelloWorld'
      '@': resolve('src'),
    }
  },
  // 定義一些文件的轉換規則
  module: {
    rules: [
      // 是否使用eslint 這裏配置是true
      ...(config.dev.useEslint ? [createLintingRule()] : []),
      {
        test: /\.vue$/,
        // vue-loader中文文檔：https://vue-loader-v14.vuejs.org/zh-cn/
        loader: 'vue-loader',
        options: vueLoaderConfig
      },
      {
        // js文件使用babel-loader轉換
        test: /\.js$/,
        loader: 'babel-loader',
        include: [resolve('src'), resolve('test'), resolve('node_modules/webpack-dev-server/client')]
      },
      {
        // 圖片文件使用url-loader轉換
        test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
        loader: 'url-loader',
        options: {
          // 限制大小10000B(bytes)之內，轉成base64編碼的dataURL字符串
          limit: 10000,
          // 輸出路徑 img/名稱.7位hash.擴展名
          name: utils.assetsPath('img/[name].[hash:7].[ext]')
        }
      },
      {
        // 視頻文件使用url-loader轉換
        test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/,
        loader: 'url-loader',
        options: {
          limit: 10000,
          name: utils.assetsPath('media/[name].[hash:7].[ext]')
        }
      },
      {
        test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
        loader: 'url-loader',
        options: {
          limit: 10000,
          name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
        }
      }
    ]
  },
  // 這裏的node是一個對象，其中每一個屬性都是 Node.js 全局變量或模塊的名稱，每一個 value 是如下其中之一
  // empty 提供空對象。
  // false 什麼都不提供。
  // 更多查看 中文文檔：https://webpack.docschina.org/configuration/node/
  node: {
    // prevent webpack from injecting useless setImmediate polyfill because Vue
    // source contains it (although only uses it if it's native). // 防止webpack注入一些polyfill 由於Vue已經包含了這些。 setImmediate: false, // prevent webpack from injecting mocks to Node native modules // that does not make sense for the client dgram: 'empty', fs: 'empty', net: 'empty', tls: 'empty', child_process: 'empty' } } 複製代碼

build/vue-loader.conf.js vue-loader配置文件

上文build/webpack.dev.conf.js提到引入了build/vue-loader.conf.js。

這個文件主要導出了一份Vue-loader的配置， 主要有：loaders，cssSourceMap，cacheBusting，transformToRequire。

具體看該文件註釋：

'use strict'
const utils = require('./utils')
const config = require('../config')
const isProduction = process.env.NODE_ENV === 'production'
const sourceMapEnabled = isProduction
  // 這裏是true
  ? config.build.productionSourceMap
  // 這裏是true
  : config.dev.cssSourceMap
// 更多配置 能夠查看vue-loader中文文檔：https://vue-loader-v14.vuejs.org/zh-cn/
module.exports = {
  // cssLoaders 生成相應loader配置，具體看utils文件中的cssLoader
  loaders: utils.cssLoaders({
    // 是否開啓sourceMap，便於調試
    sourceMap: sourceMapEnabled,
    // 是否提取vue單文件的css
    extract: isProduction
  }),
  // 是否開啓cssSourceMap，便於調試
  cssSourceMap: sourceMapEnabled,
  // 這裏是true
  // 緩存破壞，進行sourceMap debug時，設置成false頗有幫助。
  cacheBusting: config.dev.cacheBusting,
  // vue單文件中，在模板中的圖片等資源引用轉成require的形式。以便目標資源能夠由 webpack 處理。
  transformToRequire: {
    video: ['src', 'poster'],
    source: 'src',
    img: 'src',
    // 默認配置會轉換 <img> 標籤上的 src 屬性和 SVG 的 <image> 標籤上的 xlink：href 屬性。
    image: 'xlink:href'
  }
}

複製代碼

看完了這些文件相應配置，開發環境的相關配置就串起來了。其中config/文件夾下的配置，筆者都已經註釋在build/文件夾下的對應的文件中，因此就不單獨說明了。

那回過頭來看，package.json的scripts中的npm run build配置，node build/build.js，其實就是用node去執行build/build.js文件。

build/build.js npm run build 指定執行的文件

這個文件主要作了如下幾件事情：
一、引入build/check-versions文件，檢查node和npm的版本，
二、引入相關插件和配置，其中引入了webpack生產環境的配置build/webpack.prod.conf.js，
三、先控制檯輸出loading，刪除dist目錄下的文件，開始構建，構建失敗和構建成功都給出相應的提示信息。

具體能夠查看相應的註釋：

'use strict'
// 檢查node npm的版本
require('./check-versions')()

process.env.NODE_ENV = 'production'
// 命令行中的loading
const ora = require('ora')
// 刪除文件或文件夾
const rm = require('rimraf')
// 路徑相關
const path = require('path')
// 控制檯輸入樣式 chalk 更多查看：https://github.com/chalk/chalk
const chalk = require('chalk')
// 引入webpack
const webpack = require('webpack')
// 引入config/index.js
const config = require('../config')
// 引入 生產環境webpack配置
const webpackConfig = require('./webpack.prod.conf')

// 控制檯輸入開始構建loading
const spinner = ora('building for production...')
spinner.start()

// 刪除原有構建輸出的目錄文件 這裏是dist 和 static
rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => {
  // 若是出錯，拋出錯誤
  if (err) throw err
  webpack(webpackConfig, (err, stats) => {
    // 關閉 控制檯輸入開始構建loading
    spinner.stop()
    // 若是出錯，拋出錯誤
    if (err) throw err
    process.stdout.write(stats.toString({
      colors: true,
      modules: false,
      children: false, // If you are using ts-loader, setting this to true will make TypeScript errors show up during build.
      chunks: false,
      chunkModules: false
    }) + '\n\n')

    // 若是有錯，控制檯輸出構建失敗
    if (stats.hasErrors()) {
      console.log(chalk.red(' Build failed with errors.\n'))
      process.exit(1)
    }

    // 控制檯輸出構建成功相關信息
    console.log(chalk.cyan(' Build complete.\n'))
    console.log(chalk.yellow(
      ' Tip: built files are meant to be served over an HTTP server.\n' +
      ' Opening index.html over file:// won\'t work.\n' )) }) }) 複製代碼

build/check-versions 檢查node和npm版本

上文提到build/check-versions 檢查node和npm版本，這個文件主要引入了一些插件和配置，最後導出一個函數，版本不符合預期就輸出警告。

具體查看這個配置文件註釋：

'use strict'
// 控制檯輸入樣式 chalk 更多查看：https://github.com/chalk/chalk
const chalk = require('chalk')
// 語義化控制版本的插件 更多查看：https://github.com/npm/node-semver
const semver = require('semver')
// package.json配置
const packageConfig = require('../package.json')
// shell 腳本 Unix shell commands for Node.js 更多查看：https://github.com/shelljs/shelljs
const shell = require('shelljs')

function exec (cmd) {
  return require('child_process').execSync(cmd).toString().trim()
}

const versionRequirements = [
  {
    name: 'node',
    currentVersion: semver.clean(process.version),
    // 這裏配置是"node": ">= 6.0.0",
    versionRequirement: packageConfig.engines.node
  }
]
// 須要使用npm
if (shell.which('npm')) {
  versionRequirements.push({
    name: 'npm',
    currentVersion: exec('npm --version'),
    // 這裏配置是"npm": ">= 3.0.0"
    versionRequirement: packageConfig.engines.npm
  })
}
// 導出一個檢查版本的函數
module.exports = function () {
  const warnings = []

  for (let i = 0; i < versionRequirements.length; i++) {
    const mod = versionRequirements[i]

    // 當前版本不大於所需版本
    if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {
      warnings.push(mod.name + ': ' +
        chalk.red(mod.currentVersion) + ' should be ' +
        chalk.green(mod.versionRequirement)
      )
    }
  }

  // 若是有警告，所有輸出到控制檯
  if (warnings.length) {
    console.log('')
    console.log(chalk.yellow('To use this template, you must update following to modules:'))
    console.log()

    for (let i = 0; i < warnings.length; i++) {
      const warning = warnings[i]
      console.log(' ' + warning)
    }

    console.log()
    process.exit(1)
  }
}

複製代碼

build/webpack.prod.conf.js webpack生產環境配置

上文build/build.js提到，引入了這個配置文件。
這個文件主要作了如下幾件事情：
一、引入一些插件和配置，其中引入了build/webpack.base.conf.js webpack基本配置文件，
二、用DefinePlugin定義環境，
三、合併基本配置，定義本身的配置webpackConfig，配置了一些modules下的rules，devtools配置，output輸出配置，一些處理js、提取css、壓縮css、輸出html插件、提取公共代碼等的 plugins，
四、若是啓用gzip，再使用相應的插件處理，
五、若是啓用了分析打包後的插件，則用webpack-bundle-analyzer，
六、最後導出這份配置。

具體能夠查看這個文件配置註釋：

'use strict'
// 引入node路徑相關
const path = require('path')
// 引入utils工具函數
const utils = require('./utils')
// 引入webpack
const webpack = require('webpack')
// 引入config/index.js配置文件
const config = require('../config')
// 合併webpack配置的插件
const merge = require('webpack-merge')
// 基本的webpack配置
const baseWebpackConfig = require('./webpack.base.conf')
// 拷貝文件和文件夾的插件
const CopyWebpackPlugin = require('copy-webpack-plugin')
// 壓縮處理HTML的插件
const HtmlWebpackPlugin = require('html-webpack-plugin')
const ExtractTextPlugin = require('extract-text-webpack-plugin')
// 壓縮處理css的插件
const OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin')
// 壓縮處理js的插件
const UglifyJsPlugin = require('uglifyjs-webpack-plugin')

// 用DefinePlugin定義環境
const env = process.env.NODE_ENV === 'testing'
  // 這裏是 { NODE_ENV: '"testing"' }
  ? require('../config/test.env')
  // 這裏是 { NODE_ENV: '"production"' }
  : require('../config/prod.env')
// 合併基本webpack配置
const webpackConfig = merge(baseWebpackConfig, {
  module: {
    // 經過styleLoaders函數生成樣式的一些規則
    rules: utils.styleLoaders({
      // sourceMap這裏是true
      sourceMap: config.build.productionSourceMap,
      // 是否提取css到單獨的css文件
      extract: true,
      // 是否使用postcss
      usePostCSS: true
    })
  },
  // 配置使用sourceMap true 這裏是 #source-map
  devtool: config.build.productionSourceMap ? config.build.devtool : false,
  output: {
    // 這裏是根目錄下的dist
    path: config.build.assetsRoot,
    // 文件名稱 chunkhash
    filename: utils.assetsPath('js/[name].[chunkhash].js'),
    // chunks名稱 chunkhash
    chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')
  },
  plugins: [
    // http://vuejs.github.io/vue-loader/en/workflow/production.html
    // 定義具體是什麼環境
    new webpack.DefinePlugin({
      'process.env': env
    }),
    // 壓縮js插件
    new UglifyJsPlugin({
      uglifyOptions: {
        compress: {
          // 警告
          warnings: false
          // 構建後的文件 經常使用的配置還有這些
          // 去除console.log 默認爲false。  傳入true會丟棄對console函數的調用。
          // drop_console: true,
          // 去除debugger
          // drop_debugger: true,
          // 默認爲null. 你能夠傳入一個名稱的數組，而UglifyJs將會假定那些函數不會產生反作用。
          // pure_funcs: [ 'console.log', 'console.log.apply' ],
        }
      },
      // 是否開啓sourceMap 這裏是true
      sourceMap: config.build.productionSourceMap,
      // 平行處理（同時處理）加快速度
      parallel: true
    }),
    // extract css into its own file
    // 提取css到單獨的css文件
    new ExtractTextPlugin({
      // 提取到相應的文件名 使用內容hash contenthash
      filename: utils.assetsPath('css/[name].[contenthash].css'),
      // Setting the following option to `false` will not extract CSS from codesplit chunks.
      // Their CSS will instead be inserted dynamically with style-loader when the codesplit chunk has been loaded by webpack.
      // It's currently set to `true` because we are seeing that sourcemaps are included in the codesplit bundle as well when it's `false`,
      // increasing file size: https://github.com/vuejs-templates/webpack/issues/1110
      // allChunks 默認是false,true指提取全部chunks包括動態引入的組件。
      allChunks: true,
    }),
    // Compress extracted CSS. We are using this plugin so that possible
    // duplicated CSS from different components can be deduped.
    new OptimizeCSSPlugin({
      // 這裏配置是true
      cssProcessorOptions: config.build.productionSourceMap
        ? { safe: true, map: { inline: false } }
        : { safe: true }
    }),
    // generate dist index.html with correct asset hash for caching.
    // you can customize output by editing /index.html
    // see https://github.com/ampedandwired/html-webpack-plugin
    new HtmlWebpackPlugin({
      // 輸出html名稱
      filename: process.env.NODE_ENV === 'testing'
        ? 'index.html'
        // 這裏是 根目錄下的dist/index.html
        : config.build.index,
      // 使用哪一個模板
      template: 'index.html',
      // inject 默認值 true，script標籤位於html文件的 body 底部
      // body 通true, header, script 標籤位於 head 標籤內
      // false 不插入生成的 js 文件，只是單純的生成一個 html 文件
      inject: true,
      // 壓縮
      minify: {
        // 刪除註釋
        removeComments: true,
        // 刪除空格和換行
        collapseWhitespace: true,
        // 刪除html標籤中屬性的雙引號
        removeAttributeQuotes: true
        // 更多配置查看html-minifier插件
        // more options:
        // https://github.com/kangax/html-minifier#options-quick-reference
      },
      // necessary to consistently work with multiple chunks via CommonsChunkPlugin
      // 在chunk被插入到html以前，你能夠控制它們的排序。容許的值 ‘none’ | ‘auto’ | ‘dependency’ | {function} 默認爲‘auto’.
      // dependency 依賴（從屬）
      chunksSortMode: 'dependency'
    }),
    // keep module.id stable when vendor modules does not change
    // 根據代碼內容生成普通模塊的id，確保源碼不變，moduleID不變。
    new webpack.HashedModuleIdsPlugin(),
    // enable scope hoisting
    // 開啓做用域提高 webpack3新的特性，做用是讓代碼文件更小、運行的更快
    new webpack.optimize.ModuleConcatenationPlugin(),
    // split vendor js into its own file
    // 提取公共代碼
    new webpack.optimize.CommonsChunkPlugin({
      name: 'vendor',
      minChunks (module) {
        // any required modules inside node_modules are extracted to vendor
        return (
          module.resource &&
          /\.js$/.test(module.resource) &&
          module.resource.indexOf(
            path.join(__dirname, '../node_modules')
          ) === 0
        )
      }
    }),
    // extract webpack runtime and module manifest to its own file in order to
    // prevent vendor hash from being updated whenever app bundle is updated
    // 提取公共代碼
    new webpack.optimize.CommonsChunkPlugin({
      // 把公共的部分放到 manifest 中
      name: 'manifest',
      // 傳入 `Infinity` 會立刻生成 公共chunk，但裏面沒有模塊。
      minChunks: Infinity
    }),
    // This instance extracts shared chunks from code splitted chunks and bundles them
    // in a separate chunk, similar to the vendor chunk
    // see: https://webpack.js.org/plugins/commons-chunk-plugin/#extra-async-commons-chunk
    // 提取動態組件
    new webpack.optimize.CommonsChunkPlugin({
      name: 'app',
      // 若是設置爲 `true`，一個異步的  公共chunk 會做爲 `options.name` 的子模塊，和 `options.chunks` 的兄弟模塊被建立。
      // 它會與 `options.chunks` 並行被加載。能夠經過提供想要的字符串，而不是 `true` 來對輸出的文件進行更換名稱。
      async: 'vendor-async',
      // 若是設置爲 `true`，全部  公共chunk 的子模塊都會被選擇
      children: true,
      // 最小3個，包含3，chunk的時候提取
      minChunks: 3
    }),

    // copy custom static assets
    // 把static資源複製到相應目錄。
    new CopyWebpackPlugin([
      {
        from: path.resolve(__dirname, '../static'),
        // 這裏配置是static
        to: config.build.assetsSubDirectory,
        // 忽略.開頭的文件。好比這裏的.gitkeep，這個文件是指空文件夾也提交到git
        ignore: ['.*']
      }
    ])
  ]
})
// 若是開始gzip壓縮，使用compression-webpack-plugin插件處理。這裏配置是false
// 須要使用是須要安裝 npm i compression-webpack-plugin -D
if (config.build.productionGzip) {
  const CompressionWebpackPlugin = require('compression-webpack-plugin')

  webpackConfig.plugins.push(
    new CompressionWebpackPlugin({
      // asset： 目標資源名稱。 [file] 會被替換成原始資源。
      // [path] 會被替換成原始資源的路徑， [query] 會被替換成查詢字符串。默認值是 "[path].gz[query]"。
      asset: '[path].gz[query]',
      // algorithm： 能夠是 function(buf, callback) 或者字符串。對於字符串來講依照 zlib 的算法(或者 zopfli 的算法)。默認值是 "gzip"。
      algorithm: 'gzip',
      // test： 全部匹配該正則的資源都會被處理。默認值是所有資源。
      // config.build.productionGzipExtensions 這裏是['js', 'css']
      test: new RegExp(
        '\\.(' +
        config.build.productionGzipExtensions.join('|') +
        ')$'
      ),
      // threshold： 只有大小大於該值的資源會被處理。單位是 bytes。默認值是 0。
      threshold: 10240,
      // minRatio： 只有壓縮率小於這個值的資源纔會被處理。默認值是 0.8。
      minRatio: 0.8
    })
  )
}

// 輸出分析的插件 運行npm run build --report
// config.build.bundleAnalyzerReport這裏是 process.env.npm_config_report
// build結束後會自定打開 http://127.0.0.1:8888 連接
if (config.build.bundleAnalyzerReport) {
  // 更多查看連接地址：https://www.npmjs.com/package/webpack-bundle-analyzer
  const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin
  webpackConfig.plugins.push(new BundleAnalyzerPlugin())
}
// 固然也能夠用官方提供的網站 http://webpack.github.io/analyse/#home
// 運行相似 webpack --profile --json > stats.json 命令
// 把生成的構建信息stats.json上傳便可


// 最終導出 webpackConfig
module.exports = webpackConfig

複製代碼

至此，咱們就分析完了package.json中的npm run dev和npm run build兩個命令。測試相關的相似就略過吧。

npm run lint，.eslintrc.js中的配置很少，更多能夠查看eslint英文文檔或eslint中文官網，因此也略過吧。不過提一下，把eslint整合到git工做流。能夠安裝husky，npm i husky -S。安裝後，配置package.json的scripts中，配置precommit，具體以下：

"scripts": {
  "lint": "eslint --ext .js,.vue src test/unit test/e2e/specs",
  "precommit": "npm run lint",
},
複製代碼

配置好後，每次git commit -m提交會檢查代碼是否經過eslint校驗，若是沒有校驗經過則提交失敗。還能夠配置prepush。husky不斷在更新，如今可能與原先的配置不太相同了，具體查看husky github倉庫。原理就是git-hooks,pre-commit的鉤子。對shell腳本熟悉的同窗也能夠本身寫一份pre-commit。複製到項目的.git/hooks/pre-commit中。不須要依賴husky包。我司就是用的shell腳本。

最後提一下.babelrc文件中的配置。

.babelrc babel相關配置

配置了一些轉碼規則。這裏附上兩個連接：babel英文官網和babel的中文官網。

具體看文件中的配置註釋：

{
  // presets指明轉碼的規則
  "presets": [
    // env項是藉助插件babel-preset-env，下面這個配置說的是babel對es6,es7,es8進行轉碼，而且設置amd,commonjs這樣的模塊化文件，不進行轉碼
    ["env", {
      "modules": false,
      "targets": {
        "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
      }
    }],
    "stage-2"
  ],
  // plugins 屬性告訴 Babel 要使用哪些插件，插件能夠控制如何轉換代碼。
  // transform-vue-jsx 代表能夠在項目中使用jsx語法，會使用這個插件轉換
  "plugins": ["transform-vue-jsx", "transform-runtime"],
  // 在特定的環境中所執行的轉碼規則，當環境變量是下面的test就會覆蓋上面的設置
  "env": {
    // test 是提早設置的環境變量，若是沒有設置BABEL_ENV則使用NODE_ENV，若是都沒有設置默認就是development
    "test": {
      "presets": ["env", "stage-2"],
      "plugins": ["transform-vue-jsx", "transform-es2015-modules-commonjs", "dynamic-import-node"]
    }
  }
}
複製代碼

文件中presets中有配置env和stage-2，可能不知道是什麼。這裏引用深刻淺出webpack書中，第三章，3-1使用ES6語言 小節的一段，解釋一下。

presets 屬性告訴 Babel 要轉換的源碼使用了哪些新的語法特性，一個 Presets 對一組新語法特性提供支持，多個 Presets 能夠疊加。 Presets 實際上是一組 Plugins 的集合，每個 Plugin 完成一個新語法的轉換工做。Presets 是按照 ECMAScript 草案來組織的，一般能夠分爲如下三大類（書中就是說三大類，我發現就兩點~~~）：
一、已經被寫入 ECMAScript 標準裏的特性，因爲以前每一年都有新特性被加入到標準裏，因此又可細分爲：
es2015 包含在2015里加入的新特性；
es2016 包含在2016里加入的新特性；
es2017 包含在2017里加入的新特性；
es2017 包含在2017里加入的新特性；
env 包含當前全部 ECMAScript 標準裏的最新特性。
二、被社區提出來的但還未被寫入 ECMAScript 標準裏特性，這其中又分爲如下四種：
stage0 只是一個美好激進的想法，有 Babel 插件實現了對這些特性的支持，可是不肯定是否會被定爲標準；
stage1 值得被歸入標準的特性；
stage2 該特性規範已經被起草，將會被歸入標準裏；
stage3 該特性規範已經定稿，各大瀏覽器廠商和 `` 社區開始着手實現；
stage4 在接下來的一年將會加入到標準裏去。

至此，就算相對完整的分析完了Vue-cli(版本v2.9.3)搭建的webpack項目工程。但願對你們有所幫助。
項目放在筆者的github上，分析vue-cli@2.9.3 搭建的webpack項目工程。方便你們克隆下載，或者在線查看。同時也求個star ^_^，也是對筆者的一種鼓勵和支持。
筆者知識能力有限，文章有什麼不妥之處，歡迎指出~

小結

一、分析這些，逐行註釋，仍是須要一些時間的。其中有些不是很明白的地方，及時查閱相應的官方文檔和插件文檔（建議看英文文檔和最新的文檔），不過文檔沒寫明白的地方，能夠多搜索一些別人的博客文章，相對比較清晰明瞭。
二、前端發展太快，這個Vue-cli@2.9.3 webpack版本仍是v3.x，webpack如今官方版本已是v4.12.0，相信不久後，Vue-cli也將發佈支持webpack v4.x的版本，v3.0.0已是beta.16了。
三、後續有餘力，可能會繼續分析新版的vue-cli構建的webpack項目工程。

關於

做者：常以若川爲名混跡於江湖。前端路上 | PPT愛好者 | 所知甚少，惟善學。
我的博客
segmentfault前端視野專欄，開通了前端視野專欄，歡迎關注~
掘金專欄，歡迎關注~
知乎前端視野專欄，開通了前端視野專欄，歡迎關注~
github blog，求個star^_^~