vue-cli webpack配置文件分析
相信vue使用者对vue-cli都不会陌生,甚至可以说,很熟悉了,但对其webpack的配置可能知之甚少吧。
过完年回来后,我接手了公司的新项目。新项目是一个spa。很自然,我就想到了vue-cli脚手架了,当时研究一下它的webpack配置。于是,就有了其他的内容。
今天这篇文章,是在原来的基础上,增加了一些新版本的内容,但实质上变化不大。
说明
此仓库为vue-cli webpack的配置分析,其实只是在源码中加上注释而已。大家查看详细分析,可以从后面提到的入口文件开始查看。
分析不包括check-versions.js文件,因为check-versions.js是检测npm和node版本,不涉及webpack,所以就没有对check-versions.js进行分析。同时,也不包括测试部分的代码,该分析只是针对开发和生产环境的webpack配置进行分析。
vue-cli 版本
2.8.1
入口
从package.json可以看到开发和生产环境的入口。
"scripts": { "dev": "node build/dev-server.js", "build": "node build/build.js" }
开发环境
开发环境的入口文件是 build/dev-server.js。
dev-server.js
该文件中,使用express作为后端框架,结合一些关于webpack的中间件,搭建了一个开发环境。
// 配置文件 var config = require('../config') // 如果 node 的环境无法判断当前是 dev / product 环境 // 使用 config.dev.env.node_env 作为当前的环境 if (!process.env.node_env) { process.env.node_env = json.parse(config.dev.env.node_env) } // 可以强制打开浏览器并跳转到指定 url 的插件 // https://github.com/sindresorhus/opn var opn = require('opn') // node自带的文件路径工具 var path = require('path') // express框架 var express = require('express') var webpack = require('webpack') // 测试环境,使用的配置与生产环境的配置一样 // 非测试环境,即为开发环境,因为此文件只有测试环境和开发环境使用 var proxymiddleware = require('http-proxy-middleware') var webpackconfig = process.env.node_env === 'testing' // 生产环境配置文件 ? require('./webpack.prod.conf') // 开发环境配置文件 : require('./webpack.dev.conf') // 端口号为命令行输入的port参数或者配置文件中的默认值 var port = process.env.port || config.dev.port // 配置文件中 是否自动打开浏览器 var autoopenbrowser = !!config.dev.autoopenbrowser // 配置文件中 http代理配置 // https://github.com/chimurai/http-proxy-middleware var proxytable = config.dev.proxytable // 启动 express 服务 var app = express() // 启动 webpack 编译 var compiler = webpack(webpackconfig) // 可以将编译后的文件暂存到内存中的插件 // https://github.com/webpack/webpack-dev-middleware var devmiddleware = require('webpack-dev-middleware')(compiler, { // 公共路径,与webpack的publicpath一样 publicpath: webpackconfig.output.publicpath, // 不打印 quiet: true }) // hot-reload 热重载插件 // https://github.com/glenjamin/webpack-hot-middleware var hotmiddleware = require('webpack-hot-middleware')(compiler, { log: () => {} }) // 当tml-webpack-plugin template更改之后,强制刷新浏览器 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] // 如果options的数据类型为string,则表示只设置了url, // 所以需要将url设置为对象中的 target的值 if (typeof options === 'string') { options = { target: options } } app.use(proxymiddleware(options.filter || context, options)) }) // 使用 connect-history-api-fallback 匹配资源 // 如果不匹配就可以重定向到指定地址 // https://github.com/bripkens/connect-history-api-fallback app.use(require('connect-history-api-fallback')()) // 将暂存到内存中的 webpack 编译后的文件挂在到 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')) var uri = 'http://localhost:' + port // 编译成功后打印网址信息 devmiddleware.waituntilvalid(function () { console.log('> listening at ' + uri + '\n') }) module.exports = app.listen(port, function (err) { if (err) { console.log(err) return } // 如果配置了自动打开浏览器,且不是测试环境,则自动打开浏览器并跳到我们的开发地址 if (autoopenbrowser && process.env.node_env !== 'testing') { opn(uri) } })
webpack.dev.conf.js
dev-server.js中使用了webpack.dev.conf.js文件,该文件是开发环境中webpack的配置入口。
// 工具函数集合 var utils = require('./utils') var webpack = require('webpack') // 配置文件 var config = require('../config') // webpack 配置合并插件 var merge = require('webpack-merge') // webpac基本配置 var basewebpackconfig = require('./webpack.base.conf') // 自动生成 html 并且注入到 .html 文件中的插件 // https://github.com/ampedandwired/html-webpack-plugin var htmlwebpackplugin = require('html-webpack-plugin') // webpack错误信息提示插件 // https://github.com/geowarin/friendly-errors-webpack-plugin var friendlyerrorsplugin = require('friendly-errors-webpack-plugin') // 将 hol-reload 热重载的客户端代码添加到 webpack.base.conf 的 对应 entry 中,一起打包 object.keys(basewebpackconfig.entry).foreach(function(name) { basewebpackconfig.entry[name] = ['./build/dev-client'].concat(basewebpackconfig.entry[name]) }) module.exports = merge(basewebpackconfig, { module: { // styleloaders rules: utils.styleloaders({ sourcemap: config.dev.csssourcemap }) }, // 最新的配置为 cheap-module-eval-source-map,虽然 cheap-module-eval-source-map更快,但它的定位不准确 // 所以,换成 eval-source-map devtool: '#eval-source-map', plugins: [ // defineplugin 接收字符串插入到代码当中, 所以你需要的话可以写上 js 的字符串 // 此处,插入适当的环境 // https://webpack.js.org/plugins/define-plugin/ new webpack.defineplugin({ 'process.env': config.dev.env }), // hotmodule 插件在页面进行变更的时候只会重绘对应的页面模块,不会重绘整个 html 文件 // https://github.com/glenjamin/webpack-hot-middleware#installation--usage new webpack.hotmodulereplacementplugin(), new webpack.noemitonerrorsplugin(), // 将 index.html 作为入口,注入 html 代码后生成 index.html文件 // https://github.com/ampedandwired/html-webpack-plugin new htmlwebpackplugin({ filename: 'index.html', template: 'index.html', inject: true }), // webpack错误信息提示插件 new friendlyerrorsplugin() ] })
webpack.base.conf.js
在webpack.dev.conf.js中出现webpack.base.conf.js,这个文件是开发环境和生产环境,甚至测试环境,这些环境的公共webpack配置。可以说,这个文件相当重要。
// node自带的文件路径工具 var path = require('path') // 工具函数集合 var utils = require('./utils') // 配置文件 var config = require('../config') // 工具函数集合 var vueloaderconfig = require('./vue-loader.conf') /** * 获得绝对路径 * @method resolve * @param {string} dir 相对于本文件的路径 * @return {string} 绝对路径 */ function resolve(dir) { return path.join(__dirname, '..', dir) } module.exports = { entry: { app: './src/main.js' }, output: { // 编译输出的静态资源根路径 path: config.build.assetsroot, // 编译输出的文件名 filename: '[name].js', // 正式发布环境下编译输出的上线路径的根路径 publicpath: process.env.node_env === 'production' ? config.build.assetspublicpath : config.dev.assetspublicpath }, resolve: { // 自动补全的扩展名 extensions: ['.js', '.vue', '.json'], // 路径别名 alias: { // 例如 import vue from 'vue',会自动到 'vue/dist/vue.common.js'中寻找 'vue$': 'vue/dist/vue.esm.js', '@': resolve('src'), } }, module: { rules: [{ // 审查 js 和 vue 文件 // https://github.com/moox/eslint-loader test: /\.(js|vue)$/, loader: 'eslint-loader', // 表示预先处理 enforce: "pre", include: [resolve('src'), resolve('test')], options: { formatter: require('eslint-friendly-formatter') } }, { // 处理 vue文件 // https://github.com/vuejs/vue-loader test: /\.vue$/, loader: 'vue-loader', options: vueloaderconfig }, { // 编译 js // https://github.com/babel/babel-loader test: /\.js$/, loader: 'babel-loader', include: [resolve('src'), resolve('test')] }, { // 处理图片文件 // https://github.com/webpack-contrib/url-loader test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, loader: 'url-loader', query: { limit: 10000, name: utils.assetspath('img/[name].[hash:7].[ext]') } }, { // 处理字体文件 test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, loader: 'url-loader', query: { limit: 10000, name: utils.assetspath('fonts/[name].[hash:7].[ext]') } } ] } }
config/index.js
该文件在很多文件中都用到,是主要的配置文件,包含静态文件的路径、是否开启sourcemap等。其中,分为两个部分dev(开发环境的配置)和build(生产环境的配置)。
// 详情见文档:https://vuejs-templates.github.io/webpack/env.html var path = require('path') module.exports = { // production 生产环境 build: { // 构建环境 env: require('./prod.env'), // 构建输出的index.html文件 index: path.resolve(__dirname, '../dist/index.html'), // 构建输出的静态资源路径 assetsroot: path.resolve(__dirname, '../dist'), // 构建输出的二级目录 assetssubdirectory: 'static', // 构建发布的根目录,可配置为资源服务器域名或 cdn 域名 assetspublicpath: '/', // 是否开启 csssourcemap productionsourcemap: true, // gzip off by default as many popular static hosts such as // surge or netlify already gzip all static assets for you. // before setting to `true`, make sure to: // npm install --save-dev compression-webpack-plugin // 默认关闭 gzip,因为很多流行的静态资源主机,例如 surge、netlify,已经为所有静态资源开启gzip productiongzip: false, // 需要使用 gzip 压缩的文件扩展名 productiongzipextensions: ['js', 'css'], // run the build command with an extra argument to // view the bundle analyzer report after build finishes: // `npm run build --report` // set to `true` or `false` to always turn it on or off // 运行“build”命令行时,加上一个参数,可以在构建完成后参看包分析报告 // true为开启,false为关闭 bundleanalyzerreport: process.env.npm_config_report }, // dev 开发环境 dev: { // 构建环境 env: require('./dev.env'), // 端口号 port: 3333, // 是否自动打开浏览器 autoopenbrowser: true, assetssubdirectory: 'static', // 编译发布的根目录,可配置为资源服务器域名或 cdn 域名 assetspublicpath: '/', // proxytable 代理的接口(可跨域) // 使用方法:https://vuejs-templates.github.io/webpack/proxy.html proxytable: {}, // css sourcemaps off by default because relative paths are "buggy" // with this option, according to the css-loader readme // (https://github.com/webpack/css-loader#sourcemaps) // in our experience, they generally work as expected, // just be aware of this issue when enabling this option. // 默认情况下,关闭 css sourcemaps,因为使用相对路径会报错。 // css-loader readme:https://github.com/webpack/css-loader#sourcemaps csssourcemap: false } }
utils.js
utils.js也是一个被使用频率的文件,这个文件包含了三个工具函数:
- 生成静态资源的路径
- 生成 extracttextplugin对象或loader字符串
- 生成 style-loader的配置
// node自带的文件路径工具 var path = require('path') // 配置文件 var config = require('../config') // 提取css的插件 // https://github.com/webpack-contrib/extract-text-webpack-plugin var extracttextplugin = require('extract-text-webpack-plugin') /** * 生成静态资源的路径 * @method assertspath * @param {string} _path 相对于静态资源文件夹的文件路径 * @return {string} 静态资源完整路径 */ exports.assetspath = function (_path) { var assetssubdirectory = process.env.node_env === 'production' ? config.build.assetssubdirectory : config.dev.assetssubdirectory // path.posix.join与path.join一样,不过总是以 posix 兼容的方式交互 return path.posix.join(assetssubdirectory, _path) } /** * 生成处理css的loaders配置 * @method cssloaders * @param {object} options 生成配置 * option = { * // 是否开启 sourcemap * sourcemap: true, * // 是否提取css * extract: true * } * @return {object} 处理css的loaders配置对象 */ exports.cssloaders = function (options) { options = options || {} var cssloader = { loader: 'css-loader', options: { minimize: process.env.node_env === 'production', sourcemap: options.sourcemap } } /** * 生成 extracttextplugin对象或loader字符串 * @method generateloaders * @param {array} loaders loader名称数组 * @return {string|object} extracttextplugin对象或loader字符串 */ function generateloaders (loader, loaderoptions) { var loaders = [cssloader] if (loader) { loaders.push({ // 例如,sass?indentedsyntax // 在?号前加上“-loader” loader: loader + '-loader', options: object.assign({}, loaderoptions, { sourcemap: options.sourcemap }) }) } // extract为true时,提取css // 生产环境中,默认为true if (options.extract) { return extracttextplugin.extract({ use: loaders, fallback: 'vue-style-loader' }) } else { return ['vue-style-loader'].concat(loaders) } } // http://vuejs.github.io/vue-loader/en/configurations/extract-css.html return { css: generateloaders(), postcss: generateloaders(), less: generateloaders('less'), sass: generateloaders('sass', { indentedsyntax: true }), scss: generateloaders('sass'), stylus: generateloaders('stylus'), styl: generateloaders('stylus') } } /** * 生成 style-loader的配置 * style-loader文档:https://github.com/webpack/style-loader * @method styleloaders * @param {object} options 生成配置 * option = { * // 是否开启 sourcemap * sourcemap: true, * // 是否提取css * extract: true * } * @return {array} style-loader的配置 */ exports.styleloaders = function (options) { var output = [] var loaders = exports.cssloaders(options) for (var extension in loaders) { var loader = loaders[extension] output.push({ test: new regexp('\\.' + extension + '$'), use: loader }) } return output }
生产环境
开发环境的入口文件是build/build.js 。
build.js
该文件,为构建打包文件,会将源码进行构建(编译、压缩等)后打包。
// 设置当前环境为生产环境 process.env.node_env = 'production' // loading 插件 // https://github.com/sindresorhus/ora var ora = require('ora') // 可以在 node 中执行`rm -rf`的工具 // https://github.com/isaacs/rimraf var rm = require('rimraf') // node自带的文件路径工具 var path = require('path') // 在终端输出带颜色的文字 // https://github.com/chalk/chalk var chalk = require('chalk') var webpack = require('webpack') // 配置文件 var config = require('../config') var webpackconfig = require('./webpack.prod.conf') // 在终端显示loading效果,并输出提示 var spinner = ora('building for production...') spinner.start() // 删除这个文件夹 (递归删除) rm(path.join(config.build.assetsroot, config.build.assetssubdirectory), err => { if (err) throw err // 构建 webpack(webpackconfig, function (err, stats) { // 构建成功 // 停止 loading动画 spinner.stop() if (err) throw err process.stdout.write(stats.tostring({ colors: true, modules: false, children: false, chunks: false, chunkmodules: false }) + '\n\n') // 打印提示 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' )) }) })
webpack.prod.conf
该文件,为生产环境中webpack的配置入口。同时,它也依赖于前面提到的webpack.base.conf.js、utils.js和config/index.js。
// node自带的文件路径工具 var path = require('path') // 工具函数集合 var utils = require('./utils') var webpack = require('webpack') // 配置文件 var config = require('../config') // webpack 配置合并插件 var merge = require('webpack-merge') // webpack 基本配置 var basewebpackconfig = require('./webpack.base.conf') // webpack 复制文件和文件夹的插件 // https://github.com/kevlened/copy-webpack-plugin var copywebpackplugin = require('copy-webpack-plugin') // 自动生成 html 并且注入到 .html 文件中的插件 // https://github.com/ampedandwired/html-webpack-plugin var htmlwebpackplugin = require('html-webpack-plugin') // 提取css的插件 // https://github.com/webpack-contrib/extract-text-webpack-plugin var extracttextplugin = require('extract-text-webpack-plugin') // webpack 优化压缩和优化 css 的插件 // https://github.com/nmfr/optimize-css-assets-webpack-plugin var optimizecssplugin = require('optimize-css-assets-webpack-plugin') // 如果当前环境为测试环境,则使用测试环境 // 否则,使用生产环境 var env = process.env.node_env === 'testing' ? require('../config/test.env') : config.build.env var webpackconfig = merge(basewebpackconfig, { module: { // styleloaders rules: utils.styleloaders({ sourcemap: config.build.productionsourcemap, extract: true }) }, // 是否开启 sourcemap devtool: config.build.productionsourcemap ? '#source-map' : false, output: { // 编译输出的静态资源根路径 path: config.build.assetsroot, // 编译输出的文件名 filename: utils.assetspath('js/[name].[chunkhash].js'), // 没有指定输出名的文件输出的文件名 chunkfilename: utils.assetspath('js/[id].[chunkhash].js') }, plugins: [ // defineplugin 接收字符串插入到代码当中, 所以你需要的话可以写上 js 的字符串 // 此处,插入适当的环境 // http://vuejs.github.io/vue-loader/en/workflow/production.html new webpack.defineplugin({ 'process.env': env }), // 压缩 js new webpack.optimize.uglifyjsplugin({ compress: { warnings: false }, sourcemap: true }), // 提取 css new extracttextplugin({ filename: utils.assetspath('css/[name].[contenthash].css') }), // 压缩提取出来的 css // 可以删除来自不同组件的冗余代码 // compress extracted css. we are using this plugin so that possible // duplicated css from different components can be deduped. new optimizecssplugin(), // 将 index.html 作为入口,注入 html 代码后生成 index.html文件 // https://github.com/ampedandwired/html-webpack-plugin new htmlwebpackplugin({ filename: process.env.node_env === 'testing' ? 'index.html' : config.build.index, template: 'index.html', inject: true, minify: { removecomments: true, collapsewhitespace: true, removeattributequotes: true // 更多选项 https://github.com/kangax/html-minifier#options-quick-reference }, // 必须通过 commonschunkplugin一致地处理多个 chunks chunkssortmode: 'dependency' }), // 分割公共 js 到独立的文件 // https://webpack.js.org/guides/code-splitting-libraries/#commonschunkplugin new webpack.optimize.commonschunkplugin({ name: 'vendor', minchunks: function (module, count) { // node_modules中的任何所需模块都提取到vendor return ( module.resource && /\.js$/.test(module.resource) && module.resource.indexof( path.join(__dirname, '../node_modules') ) === 0 ) } }), // 将webpack runtime 和模块清单 提取到独立的文件,以防止当 app包更新时导致公共 jsd hash也更新 // 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({ name: 'manifest', chunks: ['vendor'] }), // 复制静态资源 // https://github.com/kevlened/copy-webpack-plugin new copywebpackplugin([ { from: path.resolve(__dirname, '../static'), to: config.build.assetssubdirectory, ignore: ['.*'] } ]) ] }) // 开启 gzip 的情况时,给 webpack plugins添加 compression-webpack-plugin 插件 if (config.build.productiongzip) { // webpack 压缩插件 // https://github.com/webpack-contrib/compression-webpack-plugin var compressionwebpackplugin = require('compression-webpack-plugin') // 向webpackconfig.plugins中加入下方的插件 webpackconfig.plugins.push( new compressionwebpackplugin({ asset: '[path].gz[query]', algorithm: 'gzip', test: new regexp( '\\.(' + config.build.productiongzipextensions.join('|') + ')$' ), threshold: 10240, minratio: 0.8 }) ) } // 开启包分析的情况时, 给 webpack plugins添加 webpack-bundle-analyzer 插件 if (config.build.bundleanalyzerreport) { // https://github.com/th0r/webpack-bundle-analyzer var bundleanalyzerplugin = require('webpack-bundle-analyzer').bundleanalyzerplugin webpackconfig.plugins.push(new bundleanalyzerplugin()) } module.exports = webpackconfig
其他
如果你觉得在segmentfault的代码阅读体验不好,你可以到我github上将代码clone下来看。
总结
这次研究webpack配置的时候,我自己跟着源码敲了一遍(很笨的方法),然后,在github和webpack官网上查使用到的插件的作用和用法。经过这一次折腾,加深对webpack的认识。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。