1. 程式人生 > >vue-cli中util.js詳細解讀

vue-cli中util.js詳細解讀

本文轉載自http://www.cnblogs.com/ye-hcj/p/7078047.html,在此基礎上做了部分修改

程式碼:

// 引入nodejs路徑模組
var path = require('path')
// 引入config目錄下的index.js配置檔案
var config = require('../config')
// 引入extract-text-webpack-plugin外掛,用來將css提取到單獨的css檔案中
// 詳情請看(1)
var ExtractTextPlugin = require('extract-text-webpack-plugin')
// exports其實就是一個物件,用來匯出方法的,最終還是使用module.exports,此處匯出assetsPath
exports.assetsPath = function (_path) {
// 如果是生產環境assetsSubDirectory就是'static',否則還是'static',哈哈哈
  var assetsSubDirectory = process.env.NODE_ENV === 'production'
    ? config.build.assetsSubDirectory
    : config.dev.assetsSubDirectory
// path.join和path.posix.join的區別就是,前者返回的是完整的路徑,後者返回的是完整路徑的相對根路徑
 // 也就是說path.join的路徑是C:a/a/b/xiangmu/b,那麼path.posix.join就是b
  return path.posix.join(assetsSubDirectory, _path)
// 所以這個方法的作用就是返回一個乾淨的相對根路徑
}
// 下面是匯出cssLoaders的相關配置
exports.cssLoaders = function (options) {
// options如果不為null或者undefined,0,""等等就原樣,否則就是{}。在js裡面,||運算子,A||B,A如果為真,直接返回A。如果為假,直接返回B(不會判斷B是什麼型別)
  options = options || {}

  var cssLoader = {
// cssLoader的基本配置
    loader: 'css-loader',
    options: {
// options是用來傳遞引數給loader的 
// minimize表示壓縮,如果是生產環境就壓縮css程式碼
      minimize: process.env.NODE_ENV === 'production',
// 是否開啟cssmap,預設是false
      sourceMap: options.sourceMap
    }
  }

  // generate loader string to be used with extract text plugin
  function generateLoaders (loader, loaderOptions) {
// 將上面的基礎cssLoader配置放在一個數組裡面
    var loaders = [cssLoader]
// 如果該函式傳遞了單獨的loader就加到這個loaders數組裡面,這個loader可能是less,sass之類的
    if (loader) {
// 載入對應的loader
      loaders.push({
        loader: loader + '-loader',
    // Object.assign是es6的方法,主要用來合併物件的,淺拷貝
        options: Object.assign({}, loaderOptions, {
          sourceMap: options.sourceMap
        })
      })
    }

    // Extract CSS when that option is specified
    // (which is the case during production build)
    if (options.extract) {
// 注意這個extract是自定義的屬性,可以定義在options裡面,主要作用就是當配置為true就把檔案單獨提取,false表示不單獨提取,這個可以在使用的時候單獨配置,瞬間覺得vue作者好牛逼
      return ExtractTextPlugin.extract({
        use: loaders,
        fallback: 'vue-style-loader'
      })
    } else {
      return ['vue-style-loader'].concat(loaders)
    }
// 上面這段程式碼就是用來返回最終讀取和匯入loader,來處理對應型別的檔案
  }
// 下面這段程式碼是用來當有scss或者sass型別的檔案時,新增sass-resource-loader,用於處理scss全域性定義的變數、迴圈、佔位符等檔案,其中index.scss中匯入全域性中的變數、迴圈、佔位符等檔案
function generateSassLoaders (loader, loaderOptions) {
    const loaders = generateLoaders(loader, loaderOptions)

    loaders.push({
      loader: 'sass-resources-loader',
      options: {
        resources: './src/assets/styles/index.scss'
      }
    })
    return loaders;
  }

  // https://vue-loader.vuejs.org/en/configurations/extract-css.html
  return {
    css: generateLoaders(),         // css對應 vue-style-loader 和 css-loader
    postcss: generateLoaders(),  // postcss對應 vue-style-loader 和 css-loader
    less: generateLoaders('less'),// less對應 vue-style-loader、css-loader 和 less-loader
    sass: generateSassLoaders ('sass', { indentedSyntax: true }),// sass對應 vue-style-loader、css-loader、sass-loader 和 sass-resources-loader
    scss: generateSassLoaders ('sass'),  // sass對應 vue-style-loader、css-loader、sass-loader 和 sass-resources-loader
    stylus: generateLoaders('stylus'),// stylus對應 vue-style-loader、css-loader 和 stylus-loader
    styl: generateLoaders('stylus')  // styl對應 vue-style-loader、css-loader 和 styl-loader
  }
}

// Generate loaders for standalone style files (outside of .vue)
// 下面這個主要處理import這種方式匯入的檔案型別的打包,上面的exports.cssLoaders是為這一步服務的
exports.styleLoaders = function (options) {
  var output = []
// 下面就是生成的各種css檔案的loader物件
  var loaders = exports.cssLoaders(options)
// 把每一種檔案的laoder都提取出來
  for (var extension in loaders) {
    var loader = loaders[extension]
    output.push({
    // 把最終的結果都push到output陣列中,大事搞定
      test: new RegExp('\\.' + extension + '$'),
      use: loader
    })
  }
  return output
}

註釋:

(1)extract-text-webpack-plugin外掛是用來將文字從bundle中提取到一個單獨的檔案中
   基本使用方法如下
   const ExtractTextPlugin = require("extract-text-webpack-plugin");
   module.exports = {
       module: {
           rules: [
               {
                   test: /\.css$/, //主要用來處理css檔案
                   use: ExtractTextPlugin.extract({
                       fallback: "style-loader", // fallback表示如果css檔案沒有成功匯入就使用style-loader匯入
                       use: "css-loader" // 表示使用css-loader從js讀取css檔案
                   })
               }
           ],
           plugins: [
               new ExtractTextPlugin("styles.css") //表示生成styles.css檔案
           ]
       }
   }

utils.js的exports.styleLoaders主要返回了什麼

var output=[
  {
      test: new RegExp('\\.css$'),
       use: ExtractTextPlugin.extract({
              use: [{
                loader: 'css-loader',
                options: {
                  sourceMap: true,
                  extract: true
                }
              }],
              fallback: 'vue-style-loader'
            })
  },
  {
      test: new RegExp('\\.postcss$'),
       use: ExtractTextPlugin.extract({
              use: [{
                loader: 'css-loader',
                options: {
                  sourceMap: true,
                  extract: true
                }
              }],
              fallback: 'vue-style-loader'
            })
  },
  {
      test: new RegExp('\\.less$'),
       use: ExtractTextPlugin.extract({
              use: [
                      {
                        loader: 'css-loader',
                        options: {
                          sourceMap: true,
                          extract: true
                        }
                      },
                      {
                        loader: 'less-loader',
                        options: {
                          sourceMap: true,
                          extract: true
                        }
                      }
                 ],
              fallback: 'vue-style-loader'
            })
  },
  {
      test: new RegExp('\\.sass$'),
       use: ExtractTextPlugin.extract({
              use: [
                      {
                        loader: 'css-loader',
                        options: {
                          sourceMap: true,
                          extract: true
                        }
                      },
                      {
                        loader: 'sass-loader',
                        options: {
                          sourceMap: true,
                          extract: true,
                          indentedSyntax: true
                        }
                      }
                 ],
              fallback: 'vue-style-loader'
            })
  },
  //剩下的略
]

utils.js的exports.cssLoaders主要返回了什麼

{
    css: ExtractTextPlugin.extract({
              use: [{
                loader: 'css-loader',
                options: {
                  sourceMap: true,
                  extract: true
                }
              }],
              fallback: 'vue-style-loader'
            }),
    postcss: ExtractTextPlugin.extract({
              use: [{
                loader: 'css-loader',
                options: {
                  sourceMap: true,
                  extract: true
                }
              }],
              fallback: 'vue-style-loader'
            }),
    less: ExtractTextPlugin.extract({
              use: [
                      {
                        loader: 'css-loader',
                        options: {
                          sourceMap: true,
                          extract: true
                        }
                      },
                      {
                        loader: 'less-loader',
                        options: {
                          sourceMap: true,
                          extract: true
                        }
                      }
                 ],
              fallback: 'vue-style-loader'
            }),
    sass: ExtractTextPlugin.extract({
              use: [
                      {
                        loader: 'css-loader',
                        options: {
                          sourceMap: true,
                          extract: true
                        }
                      },
                      {
                        loader: 'sass-loader',
                        options: {
                          sourceMap: true,
                          extract: true,
                          indentedSyntax: true
                        }
                      }
                 ],
              fallback: 'vue-style-loader'
            }),
   //剩下的略
  }

註釋:這是vue-loader配置的一個例項,用到utils.js的

exports.cssLoaders的返回值很合適。

vue-loader官網:https://vue-loader.vuejs.org/zh-cn/

具體配置官網:https://vue-loader.vuejs.org/zh-cn/configurations/extract-css.html

//Webpack 2.x
// webpack.config.js
var ExtractTextPlugin = require("extract-text-webpack-plugin")

module.exports = {
  // other options...
  module: {
    rules: [
      {
        test: /\.vue$/,
        loader: 'vue-loader',
        options: {
          loaders: {
            css: ExtractTextPlugin.extract({
              use: 'css-loader',
              fallback: 'vue-style-loader' // <- 這是vue-loader的依賴,所以如果使用npm3,則不需要顯式安裝
            })
          }
        }
      }
    ]
  },
  plugins: [
    new ExtractTextPlugin("style.css")
  ]
}

結束。