VUE-CLI可选的配置文件vue.config.js
VUE-CLI可选的配置文件 vue.config.js
整理自官方文档,仅供博文https://blog.csdn.net/qq_28550263/article/details/120633610 引用及做查询参考。
格式
// vue.config.jsmodule.exports = {// 配置项...
}
文档
配置项 | 含义 | 详细信息 | 备注 | 默认值 | 类型 |
---|---|---|---|---|---|
publicPath | 部署应用包时的基本 URL。 |
Vue CLI 会假设你的应用是被部署在一个域名的根路径上,例如 https://www.my-app.com/ 。如果应用被部署在一个子路径上,你就需要用这个选项指定这个子路径。
例如,如果你的应用被部署在 https://www.my-app.com/my-app/ ,则设置 publicPath 为 /my-app/ 。这个值也可以被设置为空字符串 ('' ) 或是相对路径 ('./' ),这样所有的资源都会被链接为相对路径,这样打出来的包可以被部署在任意路径,也可以用在类似 Cordova hybrid 应用的文件系统中。
|
从 Vue CLI 3.3 起已弃用baseUrl ,请使用publicPath 。
|
'/'
|
string
|
outputDir |
当运行 vue-cli-service build 时生成的生产环境构建文件的目录。
|
注意目标目录在构建之前会被清除 。 构建时传入 --no-clean 可关闭该行为
|
请始终使用 outputDir 而不要修改 webpack 的 output.path 。
|
'dist'
|
string
|
assetsDir | 放置生成的静态资源 的 目录。 |
静态资源文件如js、css、img、fonts。
路径相对于 outputDir 的
|
从生成的资源覆写 filename 或 chunkFilename 时,assetsDir 会被忽略。
|
''
|
string
|
indexPath |
指定生成的 index.html 的输出路径
|
相对于 outputDir
|
也可以是一个绝对路径 |
'index.html'
|
string
|
filenameHashing | 用于关闭文件名哈希。 | 这个选项设为 false 来关闭文件名哈希。 | 默认情况下,生成的静态资源在它们的文件名中包含了 hash 以便更好的控制缓存。然而,这也要求 index 的 HTML 是被 Vue CLI 自动生成的。如果你无法使用 Vue CLI 生成的 index HTML,你可以通过将这个选项设为 false 来关闭文件名哈希。 | true |
boolean
|
pages | 在 multi-page 模式下构建应用。每个“page”应该有一个对应的 JavaScript 入口文件。 |
其值应该是一个对象,对象的 key 是入口的名字,value 是: · 一个指定了 entry, template, filename, title 和 chunks 的对象 (除了 entry 之外都是可选的); · 或一个指定其 entry 的字符串。 |
当在 multi-page 模式下构建时,webpack 配置会包含不一样的插件 (这时会存在多个 html-webpack-plugin 和 preload-webpack-plugin 的实例)。如果你试图修改这些插件的选项,请确认运行 vue inspect 。
|
undefined
|
Object
|
- 一个指定其
entry
的字符串示例:module.exports = {pages: {index: {// page 的入口entry: 'src/index/main.js',// 模板来源template: 'public/index.html',// 在 dist/index.html 的输出filename: 'index.html',// 当使用 title 选项时,// template 中的 title 标签需要是 <title><%= htmlWebpackPlugin.options.title %></title>title: 'Index Page',// 在这个页面中包含的块,默认情况下会包含// 提取出来的通用 chunk 和 vendor chunk。chunks: ['chunk-vendors', 'chunk-common', 'index']},// 当使用只有入口的字符串格式时,// 模板会被推导为 `public/subpage.html`// 并且如果找不到的话,就回退到 `public/index.html`。// 输出文件名会被推导为 `subpage.html`。subpage: 'src/subpage/main.js'} }
配置项 | 含义 | 详细信息 | 备注 | 默认值 | 类型 |
---|---|---|---|---|---|
lintOnSave | 是否在开发环境下通过 eslint-loader 在每次保存时 lint 代码。 |
设置为 true 或 'warning' 时,eslint-loader 会将 lint 错误输出为编译警告。默认情况下,警告仅仅会被输出到命令行,且不会使得编译失败。
如果你希望让 lint 错误在开发时直接显示在浏览器中,你可以使用 lintOnSave: 'default' 。这会强制 eslint-loader 将 lint 错误输出为编译错误,同时也意味着 lint 错误将会导致编译失败。
设置为 error 将会使得 eslint-loader 把 lint 警告也输出为编译错误,这意味着 lint 警告将会导致编译失败。
|
这个值会在 @vue/cli-plugin-eslint 被安装之后生效。
|
'default'
|
boolean | 'warning' | 'default' | 'error'
|
或者,你也可以通过设置让浏览器 overlay 同时显示警告和错误:
// vue.config.js module.exports = {devServer: {overlay: {warnings: true,errors: true}} }
当
lintOnSave
是一个 truthy 的值时,eslint-loader
在开发和生产构建下都会被启用。如果你想要在生产构建时禁用eslint-loader
,你可以用如下配置:// vue.config.js module.exports = {lintOnSave: process.env.NODE_ENV !== 'production' }
配置项 | 含义 | 详细信息 | 备注 | 默认值 | 类型 |
---|---|---|---|---|---|
runtimeCompiler | 是否使用包含运行时编译器的 Vue 构建版本。 | 设置为 true 后你就可以在 Vue 组件中使用 template 选项了,但是这会让你的应用额外增加 10kb 左右。 | 更多细节可查阅:Runtime + Compiler vs. Runtime only | false |
boolean
|
transpileDependencies | 用于通过 Babel 显式转译依赖 |
默认情况下 babel-loader 会忽略所有 node_modules 中的文件。如果你想要通过 Babel 显式转译一个依赖,可以在这个选项中列出来。
|
[]
|
Array<string | RegExp>
|
|
productionSourceMap | 是否使用生产环境的 source map |
如果你不需要生产环境的 source map,可以将其设置为 false 以加速生产环境构建。
|
true
|
boolean
|
|
crossorigin |
设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 crossorigin 属性。
需要注意的是该选项仅影响由 html-webpack-plugin 在构建时注入的标签 - 直接写在模版 (public/index.html ) 中的标签不受影响。
|
更多细节可查阅: CORS settings attributes |
undefined
|
string
|
|
integrity |
在生成的 HTML 中的 <link rel="stylesheet"> 和 <script> 标签上启用 Subresource Integrity (SRI)。如果你构建后的文件是部署在 CDN 上的,启用该选项可以提供额外的安全性。
|
需要注意的是该选项仅影响由 html-webpack-plugin 在构建时注入的标签 - 直接写在模版 (public/index.html ) 中的标签不受影响。
另外,当启用 SRI 时,preload resource hints 会被禁用,因为 Chrome 的一个 bug 会导致文件被下载两次。 |
false
|
boolean
|
|
configureWebpack |
如果这个值是一个对象,则会通过 webpack-merge 合并到最终的配置中。
如果这个值是一个函数,则会接收被解析的配置作为参数。该函数既可以修改配置并不返回任何东西,也可以返回一个被克隆或合并过的配置版本。 |
更多细节可查阅:配合 webpack > 简单的配置方式 | - |
Object | Function
|
|
chainWebpack |
是一个函数,会接收一个基于 webpack-chain 的 ChainableConfig 实例。允许对内部的 webpack 配置进行更细粒度的修改。
|
更多细节可查阅:配合 webpack > 链式操作 |
Function
|
||
css.requireModuleExtension |
默认情况下,只有 *.module.[ext] 结尾的文件才会被视作 CSS Modules 模块。设置为 false 后你就可以去掉文件名中的 .module 并将所有的 *.(css|scss|sass|less|styl(us)?) 文件视为 CSS Modules 模块。
如果你在 css.loaderOptions.css 里配置了自定义的 CSS Module 选项,则 css.requireModuleExtension 必须被显式地指定为 true 或者 false,否则我们无法确定你是否希望将这些自定义配置应用到所有 CSS 文件中。 |
从 v4 起css.modules 已弃用,请使用css.requireModuleExtension 。 在 v3 中,这个选项含义与 css.requireModuleExtension 相反
|
true
|
boolean
|
|
css.extract | 是否将组件中的 CSS 提取至一个独立的 CSS 文件中 (而不是动态注入到 JavaScript 中的 inline 代码)。 |
同样当构建 Web Components 组件时它总是会被禁用 (样式是 inline 的并注入到了 shadowRoot 中)。
当作为一个库构建时,你也可以将其设置为 false 免得用户自己导入 CSS。
|
提取 CSS 在开发环境模式下是默认不开启的,因为它和 CSS 热重载不兼容。然而,你仍然可以将这个值显性地设置为 true 在所有情况下都强制提取。
|
生产环境下是 true,开发环境下是 false |
boolean | Object
|
css.sourceMap |
是否为 CSS 开启 source map。设置为 true 之后可能会影响构建的性能。
|
false
|
boolean
|
||
css.loaderOptions | 向 CSS 相关的 loader 传递选项。 |
相比于使用 chainWebpack 手动指定 loader 更推荐上面这样做,因为这些选项需要应用在使用了相应 loader 的多个地方。
|
更多细节可查阅:向预处理器 Loader 传递选项 |
{}
|
Object |
例如:
module.exports = {css: {loaderOptions: {css: {// 这里的选项会传递给 css-loader},postcss: {// 这里的选项会传递给 postcss-loader}}}
}
支持的 loader 有:
- css-loader
- postcss-loader
- sass-loader
- less-loader
- stylus-loader
另外,也可以使用scss
选项,针对scss
语法进行单独配置(区别于sass
语法)。
配置项 | 含义 | 详细信息 | 备注 | 默认值 | 类型 |
---|---|---|---|---|---|
devServer |
所有 webpack-dev-server 的选项都支持
|
些值像 host 、port 和 https 可能会被命令行参数覆写。
有些值像 publicPath 和 historyApiFallback 不应该被修改,因为它们需要和开发服务器的 publicPath 同步以保障正常的工作。
|
Object
|
||
devServer.proxy | 用于配置代理服务器 |
如果你的前端应用和后端 API 服务器没有运行在同一个主机上,你需要在开发环境下将 API 请求代理到 API 服务器。这个问题可以通过 vue.config.js 中的 devServer.proxy 选项来配置。
|
string | Object
|
devServer.proxy
可以是一个指向开发环境 API 服务器的字符串:
module.exports = {devServer: {proxy: 'http://localhost:4000'}
}
这会告诉开发服务器将任何未知请求 (没有匹配到静态文件的请求) 代理到http://localhost:4000
。
如果你想要更多的代理控制行为,也可以使用一个 path: options
成对的对象。完整的选项可以查阅 http-proxy-middleware 。
module.exports = {devServer: {proxy: {'/api': {target: '<url>',ws: true,changeOrigin: true},'/foo': {target: '<other_url>'}}}
}
配置项 | 含义 | 详细信息 | 备注 | 默认值 | 类型 |
---|---|---|---|---|---|
parallel |
是否为 Babel 或 TypeScript 使用 thread-loader 。
|
该选项在系统的 CPU 有多于一个内核时自动启用,仅作用于生产构建。 |
require('os').cpus().length > 1
|
boolean
|
|
pwa |
用于配置VUE-PWA插件:@vue/cli-plugin-pwa
|
PWA(Progressive Web Apps,渐进式 Web 应用)运用现代的 Web API 以及传统的渐进式增强策略来创建跨平台 Web 应用程序。 | PWA 是可被发现、易安装、可链接、独立于网络、渐进式、可重用、响应性和安全的。 |
Object
|
- 例如:
// vue.config.js module.exports = {// ...other vue-cli plugin options...pwa: {name: 'My App',themeColor: '#4DBA87',msTileColor: '#000000',appleMobileWebAppCapable: 'yes',appleMobileWebAppStatusBarStyle: 'black',// configure the workbox pluginworkboxPluginMode: 'InjectManifest',workboxOptions: {// swSrc is required in InjectManifest mode.swSrc: 'dev/sw.js',// ...other Workbox options...}} }
配置项 | 含义 | 详细信息 | 备注 | 默认值 | 类型 |
---|---|---|---|---|---|
pluginOptions | 用来传递任何第三方插件选项 | 这是一个不进行任何 schema 验证的对象,因此它可以用来传递任何第三方插件选项。 |
Object
|
例如:
module.exports = {pluginOptions: {foo: {// 插件可以作为 `options.pluginOptions.foo` 访问这些选项。}}
}
VUE-CLI可选的配置文件vue.config.js相关推荐
- vue cli 3 升级到 vue cli 4 方法步骤及升级点总结
vue cli 3 升级到 vue cli 4 方法步骤及升级点总结 官方升级英文文档,中文文档相对滞后. 简介:vue cli 4 官方已经更新有一段时间了,现在是4.0.5 版本,看了官方文档大概 ...
- webpack 3 零基础入门教程 #4 - webpack 的配置文件 webpack.config.js
在命令行中运行 webpack 命令确实可以实现 webpack 的功能,但是我们一般不这么做,我们要用配置文件来处理. 我们把之前学到的知识用 webpack 的配置文件来实现,配置文件的名字叫 w ...
- 使用Yarn全局安装@vue/cli,无法执行vue命令的解决方案
使用Yarn全局安装@vue/cli,无法执行vue命令的解决方案 使用Yarn全局安装@vue/cli,无法执行vue命令的解决方案 使用Yarn全局安装@vue/cli,无法执行vue命令的解决方 ...
- webpack 4.0 配置文件 webpack.config.js文件的放置位置
一般webpack.config.js是默认放在根目录的,不在根目录的时候需要在package.json中制定位置,我的配置文件目录是config/webpack.config.js,在package ...
- vue项目升级(01):全面解析vuecil3/vuecil4的vue.config.js等常用配置
前言 前端变化日新月异,层出不穷,公司原项目使用vuecil2版本开发,elementUI等一系列库版本太低,也脱离世界很久远了,新版本库需要webpack4等环境,而老版本配置起来bug很多,在使用 ...
- Vue学习笔记(九) Vue CLI
1.简介 Vue CLI 是一个基于 Vue.js 进行快速开发的完整系统,它包括三个独立的部分: CLI:一个全局安装的 npm 包,提供在终端里使用的命令 CLI 服务:一个局部安装在使用了 @v ...
- Vue CLI 官方文档(一)@vue/cli、@vue/cli-service、插件和 Preset
Vue CLI 官方文档(一)@vue/cli.@vue/cli-service.插件和 Preset 文章目录 Vue CLI 官方文档(一)@vue/cli.@vue/cli-service.插件 ...
- Vue CLI 是如何实现的 -- 终端命令行工具篇
若微信中阅读体验不佳,可点击阅读原文在 PC 端阅读. Vue CLI 是一个基于 Vue.js 进行快速开发的完整系统,提供了终端命令行工具.零配置脚手架.插件体系.图形化管理界面等.本文暂且只分析 ...
- 体验 vue cli 3.0
vue cli 3x 发布已经有好长一段时间了,webpack 4x 现在版本已经到了 4.28.0:如果你现在用或者不用手脚架搭建项目,我都推荐你使用 webpack 4x,体验一把新技术带来的变化 ...
最新文章
- scala -cp file.jar filename的案例
- 看美女有助于男士长寿
- ES6新特性之函数优化-箭头函数
- VS加快程序编译速度——以VS2013为例
- curl post https_Fiddler抓包13fiddler 抓包导出 curl 命令行
- 库依赖关系和开源供应链带来的噩梦
- PHP/JS中获取当前页面的完整URL
- 将Nginx添加到系统服务(使其可使用service命令控制)
- mysql5.6.38 设置密码_Percona Server MySQL 5.6.38修改root密码(忘记root密码)
- Java 简单工厂模式和工厂模式(类图及实现)
- 使用费马小定理和欧拉定理计算余数
- python描述对象静态特性的数据为_短期借款利息数额不大,可以直接支付,不预提,在实际支付时直接记入的账户是( )。...
- python到底有多少个库_11个你可能不知道的Python库
- Oracle中如何用一个表的数据更新另一个表中的数据_转载
- php 算生存曲线,生存分析之生存曲线绘制
- 《StereoDRNet: Dilated Residual StereoNet》
- 现代化综治网格管理模式——织网工程
- ROS中的TF坐标变换
- 【软考备战·希赛网每日一练】2023年4月17日
- php 位深度,支撑位和阻力位的分析:究竟哪些位置可以形成阻力位和支撑位? 深度教程(图解)...