手撕vue-cli配置——utils.js篇

时间 2019-11-17

标签 vue cli 配置 utils.js utils 栏目 JavaScript 繁體版

原文原文链接

utils.js文件主要是用来处理各类css loader的，好比css-loader，less-loader等。css

//引入path模块
const path = require('path')

//引入以前的config模块
const config = require('../config')

//引入“extract-text-webpack-plugin”，它的做用是打包后将生成css文件经过link的方式引入到html中，若是不使用这个插件，那么css就打包到<head>的style中
const ExtractTextPlugin = require('extract-text-webpack-plugin')

//引入package.json
const pkg = require('../package.json')

exports.assetsPath = function (_path) {
//结合config文件的代码能够知道，当环境为生产环境时，assetSubDirectory为“static”,开发环境也是“static”  
  const assetsSubDirectory = process.env.NODE_ENV === 'production'
    ? config.build.assetsSubDirectory
    : config.dev.assetsSubDirectory  
  
// path.posix.join()是path.join的一种兼容性写法，它的做用是路径的拼接，好比path.posix.join("/c/aa',"bb"); // "c/aa/bb"
  return path.posix.join(assetsSubDirectory, _path)
}

//用来生成Loader的函数 ，自己能够用在vue-loader的配置上(vue-loader.config.js文件，之后我会提这个文件)，同时也是为styleLoader函数使用（后面说）
exports.cssLoaders = function (options) {
  //若是没有传参就默认空对象
  options = options || {}

  //配置css-loader，css-loader能够让处理css中的@import或者url()
  const cssLoader = {
    loader: 'css-loader',
    options: {
      sourceMap: options.sourceMap
    }
  }
  //配置postcss-loader，主要功能是补全css中的兼容性前缀，好比“-webkit-”等
  var postcssLoader = {
    loader: 'postcss-loader',
    options: {
      sourceMap: options.sourceMap
    }
  }

  //生成loader的私有方法
  function generateLoaders (loader, loaderOptions) {
    //参数的usePostCss属性是否为true，是就使用两个loader，不然只使用css-loader
    const loaders = options.usePostCSS ? [cssLoader, postcssLoader] : [cssLoader]
    if (loader) {
      //给generateLoaders传loader参数的话，好比“less或者sass”，就将这个loader的配置传到loaders数组中
      loaders.push({
        loader: loader + '-loader',
        //Object.assign()是es6的语法，用来合并对象
        options: Object.assign({}, loaderOptions, {
          sourceMap: options.sourceMap
        })
      })
    }

    //若是options参数的extract属性为true，就使用extract text plugin将css抽成单独的文件，不然就将css写进style里
    if (options.extract) {
      return ExtractTextPlugin.extract({
        use: loaders,
        //vue-style-loader能够理解为vue版的style-loader，它能够将css放进style中
        fallback: 'vue-style-loader'
      })
    } else {
      return ['vue-style-loader'].concat(loaders)
    }
  }

  
  return {
    //返回各类loader
    css: generateLoaders(),
    postcss: generateLoaders(),
    less: generateLoaders('less'),
    sass: generateLoaders('sass', { indentedSyntax: true }),
    scss: generateLoaders('sass'),
    stylus: generateLoaders('stylus'),
    styl: generateLoaders('stylus')
  }
}

//生成开发环境下loader的配置，使用在（webpack.dev.conf.js中）
exports.styleLoaders = function (options) {
  const output = []
  //调用cssLoaders方法，返回loaders的对象
  const loaders = exports.cssLoaders(options)
  //遍历每个loader，并配置成对应的格式，传给output数组
  for (const extension in loaders) {
    const loader = loaders[extension]
    output.push({ 
      test: new RegExp('\\.' + extension + '$'),
      use: loader
    })
  }
  return output
}