前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >vue-cli#2.0 webpack 配置分析

vue-cli#2.0 webpack 配置分析

作者头像
用户1197315
发布2018-01-22 10:06:58
1.5K0
发布2018-01-22 10:06:58
举报
文章被收录于专栏:柠檬先生柠檬先生

目录结构:

├── README.md

├── build

│ ├── build.js

│ ├── check-versions.js

│ ├── dev-client.js

│ ├── dev-server.js

│ ├── utils.js

│ ├── webpack.base.conf.js

│ ├── webpack.dev.conf.js

│ └── webpack.prod.conf.js

├── config

│ ├── dev.env.js

│ ├── index.js

│ └── prod.env.js

├── index.html

├── package.json

├── src

│ ├── App.vue

│ ├── assets

│ │ └── logo.png

│ ├── components

│ │ └── Hello.vue

│ └── main.js

└── static

入口文件:package.json

代码语言:json
复制
"scripts": {
"dev": "node build/dev-server.js",
"build": "node build/build.js",
 "lint": "eslint --ext .js,.vue src" 
}

当我们执行 npm run dev / npm run build 时运行的的是 node build/dev-sev-server.js 或 node build/build.js

dev-server.js

代码语言:js
复制

  // 检查 Node 和 npm 版本
require('./check-versions')()
  // 获取 config/index.js 的默认配置
var config = require('../config')
  // 如果Node 的环境无法判断当前是dev/product 环境
  // 使用 config.dev.env.NODE_ENV 作为当前的环境
if(!process.env.NODE_ENV)process.env.NODE_ENV=JSON.parse(confi g.dev.env.NODE_ENV)
  // 使用nodeJS 自带的路径工具
var path = require('path')
  // 使用 express
var express = require('express')
  //  使用webpack
var webpack = require('webpack')
  // 一个可以强制打卡浏览器并挑战到指定url 的插件
var opn = require('opn')
  // 使用proxyTable
var proxyMiddleware = require('http-proxy-middleware')
  // 使用 dev 环境的webpack 配置
var webpackConfig = require('./webpack.dev.conf')
  // 如果没有指定运行端口,使用config.dev.port 作为运行端口
var port = process.env.PORT || config.dev.port 
  // 使用config.dev.proxyTable 的配置作为proxyTable 的代理配置
var proxyTable = config.dev.proxyTable
  // 使用 express 启动一个服务
var app = express()
  // 启动webpack 进行编译
var compiler = webpack(webpackConfig)
  // 启动 webpack-dev-middleware, 将 编译后的文件暂存到内存中
var devMiddleware =require('webpack-dev-middleware')(compiler, { publicPath: webpackConfig.output.publicPath, stats: { colors: true, chunks: false } })
  // 启动 webpack-hot-middleware, 也就是我们常说的Hot-reload
var hotMiddleware = require('webpack-hot-middleware')(compiler) compiler.plugin('compilation', function (compilation) { compilation.plugin('html-webpack-plugin-after-emit', function  (data, cb) { hotMiddleware.publish({ action: 'reload' }) cb() }) })
  // 将proxyTable 中的请求配置挂在启动的express 服务上
Object.keys(proxyTable).forEach(function (context) { var options = proxyTable[context] if (typeof options === 'string') { options = { target: options } } app.use(proxyMiddleware(context, options)) })
  // 使用 connect-hisory-api-fallback 匹配资源,如果不匹配就可以重 定向到指定地址
app.use(require('connect-history-api-fallback')())
  // 将暂存到内存中的 wepack 编译后的文件挂载带express 服务上
app.use(devMiddleware)
  // 将Hot-reload 挂载到 express 服务上
app.use(hotMiddleware)
  //拼接到 static 文件夹的静态资源路径
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
  // 为静态资源提供相应服务
app.use(staticPath, express.static('./static'))
  // 让我们这个express 服务监听port 的请求,并且将此服务作为 dev-server.js的接口暴露
module.exports = app.listen(port, function (err) { if (err) { console.log(err) return } var uri = 'http://localhost:' + port console.log('Listening at ' + uri + '\n')
  // 如果不是测试环境,自动打开浏览器并跳到我们的开发地址
if (process.env.NODE_ENV !== 'testing') { opn(uri) }
Webpack.dev.conf.js
    // 同样的使用了config/index.js
var config = require('../config')
    // 使用webpack
var webpack = require('webpack')
    //使用webpack 配置合并插件
var merge = require('webpack-merge')
    // 使用一些小工具
var utils = require('./utils')
    // 加载webpack.base.conf
var baseWebpackConfig = require('./webpack.base.conf')
    // 使用 html-webpack-plugin 插件,这个插件可以帮助我们自动生成html,并注入 到.html 文件中
var HtmlWebpackPlugin = require('html-webpack-plugin')
    // 将 Hol-reload 相对路径添加到webpack.base.conf 的 对应 entry 前
Object.keys(baseWebpackConfig.entry).forEach(function(name) {baseWebpackConfig.entry[name]=['./build/dev-client'].concat(baseWebpackConfi g.entry[name]) })
    //将我们 webpack.dev.conf.js 的配置和webpack.base.conf.js 的配置合并
module.exports = merge(baseWebpackConfig, { module: {
    // 使用 styleLoaders 
loaders: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap }) },
    // 使用 #eval-source-mao 模式作为开发工具,
module.exports = merge(baseWebpackConfig, {
 module: {
 // 使用 styleLoaders 
  loaders: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap }) },
      // eval-source-map is faster for development // 使用 #eval-source-map 模式作为开发工具,此配置可参考 DDFE 往期文章详细了解 
  devtool: '#eval-source-map', plugins: [
      // definePlugin 接收字符串插入到代码当中, 所以你需要的话可以写上 JS 的字符串 new webpack.DefinePlugin({ 'process.env': config.dev.env })
  new webpack.optimize.OccurenceOrderPlugin(),
 // HotModule 插件在页面进行变更的时候只会重回对应的页面模块,不会重绘整个 html 文件 
  new webpack.HotModuleReplacementPlugin(),
    // 使用了 NoErrorsPlugin 后页面中的报错不会阻塞,但是会在编译结束后报错 
  new webpack.NoErrorsPlugin(),
    // 将 index.html 作为入口,注入 html 代码后生成 index.html文件 
  new HtmlWebpackPlugin({ filename: 'index.html', template: 'index.html', inject: true }) ] })

Webpack.base.conf.js

代码语言:js
复制

    // 使用 nodejs 自带的文件路径
var path = require('path')
    // 引入 config/index.js
var config = require('../config')
    // 引入一些小工具
var utils = require('./utils')
    // 拼接我们的工作区路径为一个绝对路径
var projectRoot = path.resolve(__dirname, '../')
    // 将nodeJs 作为我们的编译环境
var env = process.env.NODE_ENV
    // 将在dev 环境下开启cssSourceMap 在config/index.js 中可配置
var cssSourceMapDev = (env === 'development' && config.dev.cssSourceMap)
    // 是否在production 环境下开启 ssSourceMap 在config/index.js 中可配置
var cssSourceMapProd = (env === 'production' && config.build.productionSourceMap)
    // 最终是否使用cssSourceMap
var useCssSourceMap = cssSourceMapDev || cssSourceMapProd
module.exports = {
  entry: {
      // 编译文件入口
    app: './src/main.js' 
      },
  output: {
      // 编译输出的根路径
       path: config.build.assetsRoot,
      // 正式发布环境下编译输出的发布路径
     publicPath:process.env.NODE_ENV==='production'? config.build.assetsPublicPath : config.dev.assetsPublicPath,
      // 编译输出的文件名
    filename: '[name].js' 
 },
 resolve: {
      // 自动补全的扩展名
     extensions: ['', '.js', '.vue'],
      // 不进行自动补全货处理的文件或者文件夹
  fallback: [path.join(__dirname, '../node_modules')],
    alias: {
        // 默认路径带了 例如 import vue for ‘vue’或自动到’vue/dist/vue.common.js’
      'vue': 'vue/dist/vue.common.js',
     'src': path.resolve(__dirname, '../src'),
     'assets':path.resolve(__dirname,'../src/assets'),
     'components': path.resolve(__dirname, '../src/components')
    }
    },
    resolveLoader: { fallback: [path.join(__dirname, '../node_modules')]
   },
  module: {
      preLoaders: [
          // 预处理的文件及使用的 loader 
        { test: /\.vue$/, loader: 'eslint', include: projectRoot, exclude: /node_modules/ }, { test: /\.js$/, loader: 'eslint', include: projectRoot, exclude: /node_modules/ } ], loaders: [
          //  需要处理的文件及使用的loader
        { test: /\.vue$/, loader: 'vue' },
        { test: /\.js$/, loader: 'babel', include: projectRoot, exclude: /node_modules/ }, { test: /\.json$/, loader: 'json' },
        { test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
        loader:'url',
          query: {
             limit: 10000,
            name:utils.assetsPath('img/[name].[hash:7].[ext]')
          }
      },
     {
      test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
      loader:'url',
      query:{limit:10000,
      name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
    }
   }
  ]
},
eslint: {
      // eslint 代码检查配置工具 
    formatter: require('eslint-friendly-formatter')
  },
vue: {
      //  .vue 文件配置 loader 及工具
    loaders: utils.cssLoaders({ sourceMap: useCssSourceMap }),
    postcss: [ require('autoprefixer')({ browsers: ['last 2 versions'})]
  }
}

config/index.js

代码语言:js
复制

    // 使用 nodejs 自带的文件路径
var path = require('path')
module.exports = {
  build: {
      // 使用 confi/prod.env.js 中定义的编译环境
    env: require('./prod.env'),
    index: path.resolve(__dirname, '../dist/index.html'),
      // 编译出的静态资源根路径
    assetsRoot: path.resolve(__dirname, '../dist'),
      // 编译输出的二级目录
    assetsSubDirectory: 'static',
      // 编译发布上线路径的根目录,可配置为资源服务器域名CDN 域名
    assetsPublicPath: '/',
      // 是否开启 cssSourceMap
    productionSourceMap: true,
      // 是否开启 gzip
    productionGzip: false,
      // 需要使用gzip 压缩的文件扩展名
    productionGzipExtensions: ['js', 'css']
  },
    // dev 环境
dev: {
    //  使用 config/dev.env.js 中定义的编译环境
  env: require('./dev.env'),
    // 运行测试网页的端口
 port: 8080,
    // 编译输出的二级目录
 assetsSubDirectory: 'static',
    //  编译发布上线的根目录,可以配置为资源服务器域名或CDN 域名
  assetsPublicPath: '/',
    // 需要 proxyTable 代理的接口
  proxyTable: {},
    // 是否需要开启 cssSourceMap
  cssSourceMap: false 
}}

Build.js

代码语言:js
复制

    // 检查node 和npm 版本
require('./check-versions')()
    // 使用了shelljs 插件,可以让我们在node 环境的js 中使用 shell
require('shelljs/global')
env.NODE_ENV = 'production'
    // 使用 nodejs 自带的文件路径
var path = require('path')
    // 加载config.js
var config = require('../config')
    // 一个很好看的loading 插件
var ora = require('ora')  
    // 加载 webpack
var webpack = require('webpack')
    // 加载 webpack.prod.conf
var webpackConfig = require('./webpack.prod.conf')
    // 输出提示信息~提示用户请在http 服务下查看页面,否则为空白页
console.log(
  ' Tip:\n' +
  ' Built files are meant to be served over an HTTP server.\n' +
  ' Opening index.html over file:// won\'t work.\n' 
)
    // 使用 ora 打印出loading + log
var spinner = ora('building for production...')
    // 开始loading 动画
spinner.start()
    // 拼接编译输出文件路径
var assetsPath = path.join(config.build.assetsRoot, config.build.assetsSubDirectory)
    //  删除这个文件(递归删除)
rm('-rf', assetsPath)
    //  创建此文件夹
mkdir('-p', assetsPath)
    // 复制 static 文件夹到我们的编译输出目录
cp('-R', 'static/*', assetsPath)
    // 开始 webpack 的编译
webpack(webpackConfig, function (err, stats) {
    // 编译成功的回调函数 
spinner.stop()
 if (err) throw err
process.stdout.write(stats.toString({
      colors: true,
    modules: false,
    children: false,
    chunks: false,
     chunkModules: false }) + '\n')
})

Webpack.prod.conf.js

代码语言:js
复制

      // 使用 nodejs 自带的文件路径
    var path = require('path')
      // 加载 confi.index.js
    var config = require('../config')
      // 使用一些工具
    var utils = require('./utils')
      // 加载 webpack
    var webpack = require('webpack')
      // 加载webpack 配置合并工具
    var merge = require('webpack-merge')
      // 加载 webpack.base.conf.js
    var baseWebpackConfig = require('./webpack.base.conf')
      // 一个webpack 扩展,可以提取一些代码并且将他们和文件分离开
      // 如果我们想将webpack 打包成一个文件 css js 分离开,那我们需要这个插件
    var ExtractTextPlugin = require('extract-text-webpack-plugin')
      //一个可以插入 html 并且创建新的 .html 文件的插件
    var HtmlWebpackPlugin = require('html-webpack-plugin')
    var env = config.build.env
     // 合并 webpack.base.conf.js
    var webpackConfig = merge(baseWebpackConfig, {
      module: {
          // 使用 loader
        loaders: utils.styleLoaders({
          sourceMap: config.build.productionSourceMap, extract: true })
       },
        // 是否使用 #source-map 开发工具
      devtool: config.build.productionSourceMap ? '#source-map' : false, output: {
        // 编译输出项目
      path: config.build.assetsRoot,
        // 编译输出文件名
        // 我们可以在hash 后加 :6 决定使用几位 hash 值
      filename: utils.assetsPath('js/[name].[chunkhash].js'),
        // 没有指定输出名的文件输出的文件名
      chunkFilename: utils.assetsPath('js/[id].[chunkhash].js') },
        vue: {
          //  编译 .vue 文件的使用的loader
        loaders: utils.cssLoaders({
          sourceMap: config.build.productionSourceMap, extract: true }) }, plugins: [
            // 使用的插件  definePlugin 接收字符串插入到代码当中,所以你需要的话写上
          new webpack.DefinePlugin({ 'process.env': env }),
            // 压缩js (同样可以压缩css)
          new webpack.optimize.UglifyJsPlugin({ compress: { warnings: false } }),
 new webpack.optimize.OccurrenceOrderPlugin(),
            // 将css 文件分离出来
          new ExtractTextPlugin(utils.assetsPath('css/[name].[contenthash].css')),
            // 输入 输出的 .html 文件
          new HtmlWebpackPlugin({ filename: config.build.index,template: 'index.html',
            // 是否注入 html
          inject: true,
    // 压缩的方式
      minify: {
          removeComments: true,
          collapseWhitespace: true,
          removeAttributeQuotes: true 
          chunksSortMode: 'dependency' }),
              // 没有指定输出文件名的文件输出的静态文件名
       new webpack.optimize.CommonsChunkPlugin({
          name: 'vendor',
          minChunks: function (module, count) {
      return(
        module.resource&&/\.js$/.test(module.resource)&&
        module.resource.indexOf(
           path.join(__dirname, '../node_modules')
         ) === 0 ) }
      }),
      // 没有指定输出文件名称的文件输出的静态文静名
    new webpack.optimize.CommonsChunkPlugin({
        name: 'manifest',
        chunks: ['vendor'] })
       ]
     })
      // 开启 gzip 的情况下使用下方的配置
    if (config.build.productionGzip) {
      // 加载 compression-webpack-plugin 插件 
  var CompressionWebpackPlugin = require('compression-webpack-plugin')
      // 向webpackconfig.plugins中加入下方的插件 
  var reProductionGzipExtensions='\\.('+ config.build.productionGzipExtensions.join('|') + '$)' 
    webpackConfig.plugins.push(
        // 使用 compression-webpack-plugin 插件进行压缩 
    new CompressionWebpackPlugin({
        asset: '[path].gz[query]',
         algorithm: 'gzip',
         test: new RegExp(reProductionGzipExtensions),
        // 注:此处因有代码格式化的bug,与源码有差异
         threshold: 10240, minRatio: 0.8 })
    ) }
    module.exports = webpackConfig
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2016-12-21 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • dev-server.js
  • Webpack.base.conf.js
  • config/index.js
  • Build.js
  • Webpack.prod.conf.js
相关产品与服务
内容分发网络 CDN
内容分发网络(Content Delivery Network,CDN)通过将站点内容发布至遍布全球的海量加速节点,使其用户可就近获取所需内容,避免因网络拥堵、跨运营商、跨地域、跨境等因素带来的网络不稳定、访问延迟高等问题,有效提升下载速度、降低响应时间,提供流畅的用户体验。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档