VUE-CLI可选的配置文件 vue.config.js
格式
// vue.config.js module.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 错误输出为编译警告。默认情况下,警告仅仅会被输出到命令行,且不会使得编译失败。
lintOnSave: 'default' 。这会强制 eslint-loader 将 lint 错误输出为编译错误,同时也意味着 lint 错误将会导致编译失败。
error 将会使得 eslint-loader 把 lint 警告也输出为编译错误,这意味着 lint 警告将会导致编译失败。 |
这个值会在 @vue/cli-plugin-eslint 被安装之后生效。 |
'default' |
`boolean |
- 或者,你也可以通过设置让浏览器 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 | |
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 ) 中的标签不受影响。
|
false |
boolean |
|
configureWebpack | 如果这个值是一个对象,则会通过 webpack-merge 合并到最终的配置中。
|
更多细节可查阅:配合 webpack > 简单的配置方式 | - | `Object | |
chainWebpack | 是一个函数,会接收一个基于 webpack-chain 的 ChainableConfig 实例。允许对内部的 webpack 配置进行更细粒度的修改。 |
更多细节可查阅:配合 webpack > 链式操作 | Function |
||
css.requireModuleExtension | 默认情况下,只有 *.module.[ext] 结尾的文件才会被视作 CSS Modules 模块。设置为 false 后你就可以去掉文件名中的 .module 并将所有的 `*.(css |
scss | sass | less | |
css.extract | 是否将组件中的 CSS 提取至一个独立的 CSS 文件中 (而不是动态注入到 JavaScript 中的 inline 代码)。 | 同样当构建 Web Components 组件时它总是会被禁用 (样式是 inline 的并注入到了 shadowRoot 中)。
false 免得用户自己导入 CSS。 |
提取 CSS 在开发环境模式下是默认不开启的,因为它和 CSS 热重载不兼容。然而,你仍然可以将这个值显性地设置为 true 在所有情况下都强制提取。 |
生产环境下是 true,开发环境下是 false | `boolean |
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 | ||
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 plugin workboxPluginMode: '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` 访问这些选项。 } } }