详解vue-cli的打包配置⽂件代码（给⼤家写写注释）
⼀、前⾔
对于webpack基础不好，node指令不通的童鞋。估计对⾃⼰搭建Vue、react脚⼿架是相当头疼的，有种⽆从下⼿的感觉。然⽽，从头看这2块，耗时太长，⽽且说实话得练才⾏，不练练⼿看不明⽩。那⼤多数⼈就采取折中的⽅案，修改成熟的脚⼿架，改成⾃⼰想要的样⼦。这个相对来说难度降低了不少，不过依然会有很多难点不加不明⽩。所以这⾥就以Vue的脚⼿架为例⼦，将源码加上注释，⽅便⼤家加深对项⽬配置的理解，少⾛弯路。
⼆、vue-cli 都做了什么
先跟⼤家简单说说，vue-cli 都做了什么，⼤家也对他有个⼤体的了解
1、build/dev-server.js ⽂件项⽬node的启动⽂件，这⾥⾯做了webpack配置和node操作，
2、build/f.js webpack基本配置⽂件
3、build/f.js 开发环境webpack配置
4、build/f.js 正式环境的webpack配置
5、build/build.js 执⾏打包的配置⽂件
6、config/index.js 开发、线上环境的⽂件输出、打包等⼀些配置
这是脚⼿架⾥⾯的⼀些主要配置⽂件，通过配置，整个项⽬分为开发环境和⽣产环境，不需要你多做很多繁琐的⼯作，⽤起来很⽅便，如果你想按照⾃⼰的喜好或者需求，可以修改主题⽂件的配置，下⾯我们就附上上述每个⽂件的代码和注释。 ps：代码我修改过，不是完全⼀样的，⼤家主要看看⽂件功能，和⼀些代码、组件的含义。
三、具体⽂件代码详解
1、build/dev-server.js
// 检查 Node 和 npm 版本
require('./check-versions')()
// 获取 config/index.js 的默认配置
var config = require('../config')
/
/ 如果 Node 的环境⽆法判断当前是 dev / product 环境
// 使⽤ v.NODE_ENV 作为当前的环境
if (!v.NODE_ENV) {
}
// ⼀个可以强制打开浏览器并跳转到指定 url 的插件
var opn = require('opn')
// 使⽤ NodeJS ⾃带的⽂件路径⼯具
var path = require('path')
// 使⽤ express
var express = require('express')
/
/ 使⽤ webpack
var webpack = require('webpack')
// 使⽤ proxyTable 热更新
var proxyMiddleware = require('http-proxy-middleware')
// 使⽤ dev 环境的 webpack 配置
react router 和vue routervar webpackConfig = require('./f')
// 使⽤axios请求
var axios = require('axios')
// 如果没有指定运⾏端⼝，使⽤ config.dev.port 作为运⾏端⼝
var port = v.PORT || config.dev.port
var autoOpenBrowser = !!config.dev.autoOpenBrowser
/
/ 使⽤ config.dev.proxyTable 的配置作为 proxyTable 的代理配置
var proxyTable = config.dev.proxyTable
// 使⽤ express 启动⼀个服务，URL改⼀下，这⾥是做服务转发，还可以对
var app = express()
var apiRoutes = express.Router()
<('/getDiscList', function (req, res) {
var url = 'c.y.qq/splcloud/fcgi-bin/fcg_get_diss_by_tag.fcg'
<(url, {
headers: {
referer: 'c.y.qq/',
host: 'c.y.qq'
},
params: req.query
}).then((response) => {
res.json(response.data)
}).catch((e) => {
console.log(e)
})
})
<('/lyric', function (req, res) {
var url = 'c.y.qq/lyric/fcgi-bin/fcg_query_lyric_new.fcg'
<(url, {
headers: {
referer: 'c.y.qq/',
host: 'c.y.qq'
},
params: req.query
}).then((response) => {
var ret = response.data
if (typeof ret === 'string') {
var reg = /^\w+\(({[^()]+})\)$/
var matches = ret.match(reg)
if (matches) {
ret = JSON.parse(matches[1])
}
}
res.json(ret)
}).catch((e) => {
console.log(e)
})
})
app.use('/api', apiRoutes)
var compiler = webpack(webpackConfig)
// 启动 webpack-dev-middleware，将编译后的⽂件暂存到内存中
var devMiddleware = require('webpack-dev-middleware')(compiler, {
publicPath: webpackConfig.output.publicPath,
quiet: true
})
// 启动 webpack-hot-middleware，也就是我们常说的 Hot-reload
var hotMiddleware = require('webpack-hot-middleware')(compiler, {
log: () => {}
})
// force page reload when html-webpack-plugin template changes
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(options.filter || context, options))
})
// 使⽤ 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 = 'localhost:' + port
var _resolve
var readyPromise = new Promise(resolve => {
_resolve = resolve
})
console.log('> Starting ')
devMiddleware.waitUntilValid(() => {
console.log('> Listening at ' + uri + '\n')
// 如果不是测试环境，⾃动打开浏览器并跳到我们的开发地址
if (autoOpenBrowser && v.NODE_ENV !== 'testing') {
opn(uri)
}
_resolve()
})
// 让我们这个 express 服务监听 port 的请求，并且将此服务作为 dev-server.js 的接⼝暴露var server = app.listen(port)
ready: readyPromise,
close: () => {
server.close()
}
}
2、build/f.js
var path = require('path')
var utils = require('./utils')
var config = require('../config')
// .vue ⽂件配置 loader 及⼯具 (autoprefixer)
var vueLoaderConfig = require('./f')
// 拼接我们的⼯作区路径为⼀个绝对路径的函数
function resolve(dir) {
return path.join(__dirname, '..', dir)
}
// webpack 配置，输⼊、输出、模块、插件
entry: {
app: './src/main.js'
},
output: {
// 编译输出的根路径
path: config.build.assetsRoot,
// 编译输出的⽂件名
filename: '[name].js',
// 正式发布环境下编译输出的发布路径
publicPath: v.NODE_ENV === 'production'
? config.build.assetsPublicPath
: config.dev.assetsPublicPath
},
resolve: {
// ⾃动补全的扩展名
extensions: ['.js', '.vue', '.json'],
// 默认路径代理，即起别名，例如 import Vue from 'vue'，会⾃动到 'vue/dist/vuemon.js'中寻 alias: {
'@': resolve('src'),
'common': resolve('src/common'),
'components': resolve('src/components'),
'base': resolve('src/base'),
'api': resolve('src/api')
}
},
module: {
rules: [
// 需要处理的⽂件及使⽤的 loader
{
test: /\.(js|vue)$/,
loader: 'eslint-loader',
enforce: 'pre',
include: [resolve('src'), resolve('test')],
options: {
// eslint 代码检查配置⼯具
formatter: require('eslint-friendly-formatter')
}
},
{
test: /\.vue$/,
loader: 'vue-loader',
options: vueLoaderConfig
},
{
test: /\.js$/,
loader: 'babel-loader',
include: [resolve('src'), resolve('test')]
},
{
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
loader: 'url-loader',
options: {
limit: 10000,
name: utils.assetsPath('img/[name].[hash:7].[ext]')
}
},
{
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
loader: 'url-loader',
options: {
limit: 10000,
name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
}
}
]
}
}
3、build/f.js
/
/ 使⽤⼀些⼩⼯具
var utils = require('./utils')
var webpack = require('webpack')
// 同样的使⽤了 config/index.js 的预设配置
var config = require('../config')
// 使⽤ webpack 配置合并插件
var merge = require('webpack-merge')
// 加载 f
var baseWebpackConfig = require('./f')
// 使⽤ html-webpack-plugin 插件，这个插件可以帮我们⾃动⽣成 html 并且注⼊到 .html ⽂件中
var HtmlWebpackPlugin = require('html-webpack-plugin')
/
/ ⼀个友好的错误提⽰插件
var FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin')
// 将 Hol-reload 相对路径添加到 f 的对应 entry 前
Object.).forEach(function (name) {
<[name] = ['./build/dev-client'].[name]) })
// 将我们 f.js 的配置和 f.js 的配置合并
module: {
// 使⽤ styleLoaders
rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
},
/
/ 使⽤ #eval-source-map 模式作为开发⼯具，此配置可参考 DDFE 往期⽂章详细了解
devtool: '#cheap-module-eval-source-map',
plugins: [
// definePlugin 接收字符串插⼊到代码当中, 所以你需要的话可以写上 JS 的字符串
new webpack.DefinePlugin({
'v': v
}),
// definePlugin 接收字符串插⼊到代码当中, 所以你需要的话可以写上 JS 的字符串
// HotModule 插件在页⾯进⾏变更的时候只会重回对应的页⾯模块，不会重绘整个 html ⽂件new webpack.HotModuleReplacementPlugin(),
// 遇到报错，跳过还⾏，并提⽰错误信息
new webpack.NoEmitOnErrorsPlugin(),
// 将 index.html 作为⼊⼝，注⼊ html 代码后⽣成 index.html⽂件
new HtmlWebpackPlugin({
filename: 'index.html',
template: 'index.html',
inject: true
}),
// 使⽤这个插件，更好的输出错误信息
new FriendlyErrorsPlugin()
]
})
4、build/f.js
var path = require('path')
var utils = require('./utils')
var webpack = require('webpack')
var config = require('../config')
// 加载 webpack 配置合并⼯具
var merge = require('webpack-merge')
// 加载 f.js⽂件
var baseWebpackConfig = require('./f')
var CopyWebpackPlugin = require('copy-webpack-plugin')
// ⼀个可以插⼊ html 并且创建新的 .html ⽂件的插件
var HtmlWebpackPlugin = require('html-webpack-plugin')
/
/ ⼀个 webpack 扩展，可以提取⼀些代码并且将它们和⽂件分离开
// 如果我们想将 webpack 打包成⼀个⽂件 css js 分离开，那我们需要这个插件
var ExtractTextPlugin = require('extract-text-webpack-plugin')
var OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin')
var env = v
// 合并 f.js
var webpackConfig = merge(baseWebpackConfig, {
module: {
// 使⽤的 loader
rules: utils.styleLoaders({
sourceMap: config.build.productionSourceMap,
extract: true
})
},
// 是否使⽤ #source-map 开发⼯具，更多信息可以查看 DDFE 往期⽂章
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')
},
plugins: [
// definePlugin 接收字符串插⼊到代码当中, 所以你需要的话可以写上 JS 的字符串
new webpack.DefinePlugin({
'v': env
}),
// 压缩 js (同样可以压缩 css)
new webpack.optimize.UglifyJsPlugin({
compress: {
warnings: false
},
sourceMap: true
}),
// 将 css ⽂件分离出来
new ExtractTextPlugin({
filename: utils.assetsPath('css/[name].[contenthash].css')
}),
// Compress extracted CSS. We are using this plugin so that possible
// duplicated CSS from different components can be deduped.
new OptimizeCSSPlugin({
cssProcessorOptions: {
safe: true
}
}),
// 输⼊输出的 .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) {
/
/ any required modules inside node_modules are extracted to vendor
return (
/\.js$/.source) &&
path.join(__dirname, '../node_modules')
) === 0
)
}
}),
// 没有指定输出⽂件名的⽂件输出的静态⽂件名
new webpack.optimize.CommonsChunkPlugin({
name: 'manifest',
chunks: ['vendor']
}),
// copy custom static assets
new CopyWebpackPlugin([
{
from: solve(__dirname, '../static'),
to: config.build.assetsSubDirectory,
ignore: ['.*']
}
]
)
]
})
// 开启 gzip 的情况下使⽤下⽅的配置
if (config.build.productionGzip) {
// 加载 compression-webpack-plugin 插件
var CompressionWebpackPlugin = require('compression-webpack-plugin')
webpackConfig.plugins.push(
// 使⽤ compression-webpack-plugin 插件进⾏压缩
new CompressionWebpackPlugin({
asset: '[path].gz[query]',
algorithm: 'gzip',
test: new RegExp(
'\\.(' +
config.build.productionGzipExtensions.join('|') +
')$'
),
threshold: 10240,
minRatio: 0.8
})
)
}
if (config.build.bundleAnalyzerReport) {
// 懒加载插件
var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin webpackConfig.plugins.push(new BundleAnalyzerPlugin())
}
5、build/build.js
// 检查 Node 和 npm 版本
require('./check-versions')()
// 当node⽆法判断是本地还是线上时，这⾥默认写上线上
// ⼀个很好看的 loading 插件
var ora = require('ora')
var rm = require('rimraf')
var path = require('path')
var chalk = require('chalk')
var webpack = require('webpack')
var config = require('../config')
// 加载 f⽂件
var webpackConfig = require('./f')
// 使⽤ ora 打印出 loading + log
var spinner = ora('building ')
// 开始 loading 动画
spinner.start()
// 删除打包后的⽂件夹，重新⽣成打包后的⽂件
rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => {
if (err) throw err
// 开始 webpack 的编译
webpack(webpackConfig, function (err, stats) {
// 编译成功的回调函数
spinner.stop()
if (err) throw err
process.stdout.String({
colors: true,
modules: false,
children: false,
chunks: false,
chunkModules: false
}) + '\n\n')
console.an(' Build complete.\n'))
console.llow(
' Tip: built files are meant to be served over an HTTP server.\n' +
' Opening index.html over file:// won\'t work.\n'
))
})
})
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论