详解 vue-cli 的打包配置文件代码（带注释）

2024-08-31 20:08
文章标签 javascript 代码 详解 vue 打包 配置文件 注释 frontend cli

本文主要是介绍详解 vue-cli 的打包配置文件代码（带注释），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一、前言

　　对于webpack基础不好，node指令不通的童鞋。估计对自己搭建Vue、react脚手架是相当头疼的，有种无从下手的感觉。然而，从头看这2块，耗时太长，而且说实话得练才行，不练练手看不明白。那大多数人就采取折中的方案，修改成熟的脚手架，改成自己想要的样子。这个相对来说难度降低了不少，不过依然会有很多难点不加不明白。所以这里就以Vue的脚手架为例子，将源码加上注释，方便大家加深对项目配置的理解，少走弯路。

 

二、vue-cli 都做了什么

　　先跟大家简单说说，vue-cli 都做了什么，大家也对他有个大体的了解

　　1、build/dev-server.js  文件 项目node的启动文件，这里面做了webpack配置和node操作，

　　2、build/webpack.base.conf.js   webpack基本配置文件

　　3、build/webpack.dev.conf.js  开发环境webpack配置

　　4、build/webpack.prod.conf.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 环境
// 使用 config.dev.env.NODE_ENV 作为当前的环境
if (!process.env.NODE_ENV) {process.env.NODE_ENV = JSON.parse(config.dev.env.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 配置
var webpackConfig = require('./webpack.dev.conf')
// 使用axios请求
var axios = require('axios')// 如果没有指定运行端口，使用 config.dev.port 作为运行端口
var port = process.env.PORT || config.dev.portvar autoOpenBrowser = !!config.dev.autoOpenBrowser// 使用 config.dev.proxyTable 的配置作为 proxyTable 的代理配置
var proxyTable = config.dev.proxyTable
// 使用 express 启动一个服务，URL改一下，这里是做服务转发，还可以对
var app = express()var apiRoutes = express.Router()apiRoutes.get('/getDiscList', function (req, res) {var url = 'https://c.y.qq.com/splcloud/fcgi-bin/fcg_get_diss_by_tag.fcg'axios.get(url, {headers: {referer: 'https://c.y.qq.com/',host: 'c.y.qq.com'},params: req.query}).then((response) => {res.json(response.data)}).catch((e) => {console.log(e)})
})apiRoutes.get('/lyric', function (req, res) {var url = 'https://c.y.qq.com/lyric/fcgi-bin/fcg_query_lyric_new.fcg'axios.get(url, {headers: {referer: 'https://c.y.qq.com/',host: 'c.y.qq.com'},params: req.query}).then((response) => {var ret = response.dataif (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 = 'http://localhost:' + portvar _resolve
var readyPromise = new Promise(resolve => {_resolve = resolve
})console.log('> Starting dev server...')
devMiddleware.waitUntilValid(() => {console.log('> Listening at ' + uri + '\n')// 如果不是测试环境，自动打开浏览器并跳到我们的开发地址if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') {opn(uri)}_resolve()
})
// 让我们这个 express 服务监听 port 的请求，并且将此服务作为 dev-server.js 的接口暴露
var server = app.listen(port)module.exports = {ready: readyPromise,close: () => {server.close()}
}

 

 

　　2、build/webpack.base.conf.js

var path = require('path')
var utils = require('./utils')
var config = require('../config')
// .vue 文件配置 loader 及工具 (autoprefixer)
var vueLoaderConfig = require('./vue-loader.conf')
// 拼接我们的工作区路径为一个绝对路径的函数
function resolve(dir) {return path.join(__dirname, '..', dir)
}// webpack 配置，输入、输出、模块、插件
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'],// 默认路径代理，即起别名，例如 import Vue from 'vue'，会自动到 'vue/dist/vue.common.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/webpack.dev.conf.js

// 使用一些小工具
var utils = require('./utils')
var webpack = require('webpack')
// 同样的使用了 config/index.js 的预设配置
var config = require('../config')
// 使用 webpack 配置合并插件
var merge = require('webpack-merge')
// 加载 webpack.base.conf
var baseWebpackConfig = require('./webpack.base.conf')
// 使用 html-webpack-plugin 插件，这个插件可以帮我们自动生成 html 并且注入到 .html 文件中
var HtmlWebpackPlugin = require('html-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])
})
// 将我们 webpack.dev.conf.js 的配置和 webpack.base.conf.js 的配置合并
module.exports = merge(baseWebpackConfig, {module: {// 使用 styleLoadersrules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })},// 使用 #eval-source-map 模式作为开发工具，此配置可参考 DDFE 往期文章详细了解devtool: '#cheap-module-eval-source-map',plugins: [// definePlugin 接收字符串插入到代码当中, 所以你需要的话可以写上 JS 的字符串new webpack.DefinePlugin({'process.env': config.dev.env}),// 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/webpack.prod.conf.js 

var path = require('path')
var utils = require('./utils')
var webpack = require('webpack')
var config = require('../config')
// 加载 webpack 配置合并工具
var merge = require('webpack-merge')
// 加载 webpack.base.conf.js文件
var baseWebpackConfig = require('./webpack.base.conf')
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 = config.build.env// 合并 webpack.base.conf.js
var webpackConfig = merge(baseWebpackConfig, {module: {// 使用的 loaderrules: 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({'process.env': 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',// 是否注入 htmlinject: 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 vendorreturn (module.resource &&/\.js$/.test(module.resource) &&module.resource.indexOf(path.join(__dirname, '../node_modules')) === 0)}}),// 没有指定输出文件名的文件输出的静态文件名new webpack.optimize.CommonsChunkPlugin({name: 'manifest',chunks: ['vendor']}),// copy custom static assetsnew CopyWebpackPlugin([{from: path.resolve(__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').BundleAnalyzerPluginwebpackConfig.plugins.push(new BundleAnalyzerPlugin())
}module.exports = webpackConfig

 

 

　　5、build/build.js

 

// 检查 Node 和 npm 版本
require('./check-versions')()
// 当node无法判断是本地还是线上时，这里默认写上线上
process.env.NODE_ENV = 'production'
// 一个很好看的 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')
// 加载 webpack.prod.conf文件
var webpackConfig = require('./webpack.prod.conf')
// 使用 ora 打印出 loading + log
var spinner = ora('building for production...')
// 开始 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 errprocess.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'))})
})

　　6、config/index.js

// see http://vuejs-templates.github.io/webpack for documentation.
var path = require('path')
module.exports = {// production 环境build: {// 使用 config/prod.env.js 中定义的编译环境env: require('./prod.env'),port: 9000,index: path.resolve(__dirname, '../dist/index.html'),// 编译输出的静态资源根路径assetsRoot: path.resolve(__dirname, '../dist'),// 编译输出的二级目录assetsSubDirectory: 'static',// 编译发布上线路径的根目录，可配置为资源服务器域名或 CDN 域名assetsPublicPath: '',// 是否开启 cssSourceMapproductionSourceMap: true,// 是否开启 gzipproductionGzip: false,// 需要使用 gzip 压缩的文件扩展名productionGzipExtensions: ['js', 'css'],// 插件叫做bundleAnalyzerReport，上面有几行注释，讲的是只要在打包的时候输入npm run build --report,就可以在打包的同时查看每个打包生成的js，里面的库的构成情况，方便我们进行相关的删减，比如有的库太大了，是否可以自己实现，有的库是否有必要，可否删除之类bundleAnalyzerReport: process.env.npm_config_report},// 使用 config/dev.env.js 中定义的编译环境dev: {env: require('./dev.env'),// 运行测试页面的端口port: 8080,// 是否自动打开浏览器autoOpenBrowser: true,// 编译输出的二级目录assetsSubDirectory: 'static',// 编译发布上线路径的根目录，可配置为资源服务器域名或 CDN 域名assetsPublicPath: '/',// 需要 proxyTable 代理的接口（可跨域）proxyTable: {},// 是否开启 cssSourceMapcssSourceMap: false}
}

四、小结

　　上述就是vue-cli的主要文件详解了，由于涉及的东西比较多，有一些我也不是很熟悉，只能对大家做一个简单的解释。至于里面具体模块，有兴趣的可以自己去Google。

如果，注释或者言论有不当、错误之处，还请童鞋们之处。以免误导他人。   ps： 喜欢我博客的朋友，可以关注一下，我们沟通技术互相进步！

这篇关于详解 vue-cli 的打包配置文件代码（带注释）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1124871。

相关文章

CSS3 布局样式及其应用举例

CSS3 布局样式及其应用举例

《CSS3布局样式及其应用举例》CSS3的布局特性为前端开发者提供了无限可能，无论是Flexbox的一维布局还是Grid的二维布局，它们都能够帮助开发者以更清晰、简洁的方式实现复杂的网页布局，本文给... 目录深入探讨 css3 布局样式及其应用引言一、CSS布局的历史与发展1.1 早期布局的局限性1.2
阅读更多...
使用animation.css库快速实现CSS3旋转动画效果

使用animation.css库快速实现CSS3旋转动画效果

《使用animation.css库快速实现CSS3旋转动画效果》随着Web技术的不断发展，动画效果已经成为了网页设计中不可或缺的一部分，本文将深入探讨animation.css的工作原理，如何使用以及... 目录1. css3动画技术简介2. animation.css库介绍2.1 animation.cs
阅读更多...
Spring Boot项目打包和运行的操作方法

Spring Boot项目打包和运行的操作方法

《SpringBoot项目打包和运行的操作方法》SpringBoot应用内嵌了Web服务器,所以基于SpringBoot开发的web应用也可以独立运行,无须部署到其他Web服务器中,下面以打包dem... 目录一、打包为JAR包并运行1.打包为可执行的 JAR 包2.运行 JAR 包二、打包为WAR包并运行
阅读更多...
CSS引入方式和选择符的讲解和运用小结

CSS引入方式和选择符的讲解和运用小结

《CSS引入方式和选择符的讲解和运用小结》CSS即层叠样式表，是一种用于描述网页文档（如HTML或XML）外观和格式的样式表语言,它主要用于将网页内容的呈现（外观）和结构（内容）分离，从而实现... 目录一、前言二、css 是什么三、CSS 引入方式1、行内样式2、内部样式表3、链入外部样式表四、CSS 选
阅读更多...
Java进行日期解析与格式化的实现代码

Java进行日期解析与格式化的实现代码

《Java进行日期解析与格式化的实现代码》使用Java搭配ApacheCommonsLang3和Natty库,可以实现灵活高效的日期解析与格式化,本文将通过相关示例为大家讲讲具体的实践操作,需要的可以... 目录一、背景二、依赖介绍1. Apache Commons Lang32. Natty三、核心实现代
阅读更多...
C#特性(Attributes)和反射(Reflection)详解

C#特性(Attributes)和反射(Reflection)详解

《C#特性(Attributes)和反射(Reflection)详解》：本文主要介绍C#特性(Attributes)和反射(Reflection),具有很好的参考价值,希望对大家有所帮助,如有错误... 目录特性特性的定义概念目的反射定义概念目的反射的主要功能包括使用反射的基本步骤特性和反射的关系总结特性
阅读更多...
使用雪花算法产生id导致前端精度缺失问题解决方案

使用雪花算法产生id导致前端精度缺失问题解决方案

《使用雪花算法产生id导致前端精度缺失问题解决方案》雪花算法由Twitter提出,设计目的是生成唯一的、递增的ID,下面：本文主要介绍使用雪花算法产生id导致前端精度缺失问题的解决方案,文中通过代... 目录一、问题根源二、解决方案1. 全局配置Jackson序列化规则2. 实体类必须使用Long封装类3.
阅读更多...
详解如何在SpringBoot控制器中处理用户数据

详解如何在SpringBoot控制器中处理用户数据

《详解如何在SpringBoot控制器中处理用户数据》在SpringBoot应用开发中,控制器（Controller）扮演着至关重要的角色,它负责接收用户请求、处理数据并返回响应,本文将深入浅出地讲解... 目录一、获取请求参数1.1 获取查询参数1.2 获取路径参数二、处理表单提交2.1 处理表单数据三、
阅读更多...
PyQt6中QMainWindow组件的使用详解

PyQt6中QMainWindow组件的使用详解

《PyQt6中QMainWindow组件的使用详解》QMainWindow是PyQt6中用于构建桌面应用程序的基础组件,本文主要介绍了PyQt6中QMainWindow组件的使用,具有一定的参考价值,... 目录1. QMainWindow 组php件概述2. 使用 QMainWindow3. QMainW
阅读更多...
使用Python自动化生成PPT并结合LLM生成内容的代码解析

使用Python自动化生成PPT并结合LLM生成内容的代码解析

《使用Python自动化生成PPT并结合LLM生成内容的代码解析》PowerPoint是常用的文档工具,但手动设计和排版耗时耗力,本文将展示如何通过Python自动化提取PPT样式并生成新PPT,同时... 目录核心代码解析1. 提取 PPT 样式到 jsON关键步骤：代码片段：2. 应用 JSON 样式到
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2