vue.config.js 配置参考

文章目录

属性说明
常用完整配置

属性说明

vue.config.js是一个可选的配置文件，如果项目的 (和 package.json 同级的) 根目录中存在这个文件，那么它会被 @vue/cli-service 自动加载。你也可以使用 package.json 中的 vue 字段，但是注意这种写法需要你严格遵照 JSON 的格式来写。

若没有vue.config.js文件可以自行在根目录创建。

// vue.config.js
module.exports = {// 选项
}

baseUrl
从 Vue CLI 3.3 起已弃用，请使用publicPath。

publicPath

默认：'/'

部署应用包时的基本 URL，Vue CLI 会假设你的应用是被部署在一个域名的根路径上，如果是部署在一个子路径上，比如在https://www.my-app.com/my-app/，则设置publicPath: /my-app/。
这个值也可以被设置为空字符串 ('') 或是相对路径 ('./')，这样所有的资源都会被链接为相对路径，方便迁移。

相对publicPath的限制，在以下情况下，应当避免使用相对 publicPath:：

当使用基于 HTML5 history.pushState 的路由时；

当使用 pages 选项构建多页面应用时。

outputDir

默认：‘dist’

当运行vue-cli-service build时生成的生产环境构建文件的目录。注意目标目录在构建之前会被清除 (构建时传入--no-clean 可关闭该行为)。

请始终使用outputDir而不要修改 webpack 的output.path。

assetsDir

默认：''

放置生成的静态资源 (js、css、img、fonts)的 (相对于 outputDir 的) 目录。

从生成的资源覆写 filename 或 chunkFilename 时，assetsDir 会被忽略。

indexPath

默认：'index.html'

指定生成的index.html 的输出路径 (相对于 outputDir)。也可以是一个绝对路径。

filenameHashing

默认：true

默认情况下，生成的静态资源在它们的文件名中包含了hash 以便更好的控制缓存。然而，这也要求index的 HTML 是被 Vue CLI自动生成的。如果你无法使用 Vue CLI 生成的 index HTML，你可以通过将这个选项设为false 来关闭文件名哈希。

pages

默认：undefined

在 multi-page 模式下构建应用。每个“page”应该有一个对应的 JavaScript 入口文件。其值应该是一个对象，对象的 key 是入口的名字，value 可以是对象或字符串，类似：

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

默认：default (可选值：‘warning’ | ‘default’ | ‘error’)

是否在开发环境下通过eslint-loader在每次保存时lint代码。这个值会在 @vue/cli-plugin-eslint被安装之后生效。

值	说明
true / ‘warning’	编译警告，仅仅会被输出到命令行，且不会使得编译失败
default	错误在开发时直接显示在浏览器中，编译错误，同时也意味着 lint 错误将会导致编译失败
error	编译错误，导致编译失败

runtimeCompiler

默认：false

是否使用包含运行时编译器的 Vue 构建版本。设置为 true 后你就可以在 Vue 组件中使用 template选项了，但是这会让你的应用额外增加 10kb 左右。

在使用函数式组件的时候就需要配置true了

transpileDependencies

默认：[]

默认情况下babel-loader会忽略所有 node_modules中的文件。如果你想要通过 Babel 显式转译一个依赖，可以在这个选项中列出来。

productionSourceMap

默认：true

如果你不需要生产环境的 source map，可以将其设置为false 以加速生产环境构建。

crossorigin

默认：undefined

设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 crossorigin 属性。

需要注意的是该选项仅影响由 html-webpack-plugin 在构建时注入的标签 - 直接写在模版(public/index.html)中的标签不受影响。

integrity

默认：false

在生成的 HTML 中的<link rel="stylesheet"> 和<script>标签上启用Subresource Integrity (SRI)。如果你构建后的文件是部署在 CDN 上的，启用该选项可以提供额外的安全性。

需要注意的是该选项仅影响由 html-webpack-plugin 在构建时注入的标签 - 直接写在模版(public/index.html) 中的标签不受影响。
另外，当启用 SRI 时，preload resource hints 会被禁用，因为 Chrome 的一个 bug 会导致文件被下载两次。

configureWebpack

如果这个值是一个对象，则会通过 webpack-merge合并到最终的配置中。

如果这个值是一个函数，则会接收被解析的配置作为参数。该函数既可以修改配置并不返回任何东西，也可以返回一个被克隆或合并过的配置版本。
配合 webpack > 简单的配置方式

chainWebpack

是一个函数，会接收一个基于 webpack-chain 的 ChainableConfig实例。允许对内部的webpack配置进行更细粒度的修改。
配合 webpack > 链式操作

**css.modules **
从 v4 起已弃用，请使用css.requireModuleExtension。在 v3 中，这个选项含义与 css.requireModuleExtension相反。

css.requireModuleExtension

默认：true

默认情况下，只有 *.module.[ext]结尾的文件才会被视作CSS Modules 模块。设置为 false后你就可以去掉文件名中的.module并将所有的 *.(css|scss|sass|less|styl(us)?)文件视为 CSS Modules模块。

如果你在 css.loaderOptions.css里配置了自定义的 CSS Module选项，则 css.requireModuleExtension必须被显式地指定为true或者false，否则我们无法确定你是否希望将这些自定义配置应用到所有 CSS文件中。

css.extract

默认：生产环境下是 true，开发环境下是 false

是否将组件中的 CSS 提取至一个独立的 CSS 文件中 (而不是动态注入到 JavaScript中的inline代码)。
同样当构建 Web Components组件时它总是会被禁用 (样式是 inline 的并注入到了 shadowRoot 中)。

当作为一个库构建时，你也可以将其设置为false免得用户自己导入 CSS。

提取 CSS 在开发环境模式下是默认不开启的，因为它和 CSS 热重载不兼容。然而，你仍然可以将这个值显性地设置为 true 在所有情况下都强制提取。

css.sourceMap

默认：false

是否为 CSS 开启 source map。设置为true之后可能会影响构建的性能。

css.loaderOptions

默认：{}

module.exports = {css: {loaderOptions: {css: {// 这里的选项会传递给 css-loader},postcss: {// 这里的选项会传递给 postcss-loader}}}
}

支持的 loader 有：

css-loader
postcss-loader
sass-loader
less-loader
stylus-loader

另外，也可以使用 scss 选项，针对scss 语法进行单独配置（区别于sass语法）。

相比于使用chainWebpack 手动指定loader更推荐上面这样做，因为这些选项需要应用在使用了相应 loader的多个地方。

devServer
所有webpack-dev-server的选项都支持。
注意：

有些值像 host、port和 https 可能会被命令行参数覆写。
有些值像 publicPath 和 historyApiFallback 不应该被修改，因为它们需要和开发服务器的 publicPath 同步以保障正常的工作。

devServer.proxy
如果你的前端应用和后端 API 服务器没有运行在同一个主机上，你需要在开发环境下将 API 请求代理到 API 服务器。这个问题可以通过vue.config.js 中的 devServer.proxy 选项来配置。

module.exports = {devServer: {proxy: 'http://localhost:6666'}
}

这会告诉开发服务器将任何未知请求 (没有匹配到静态文件的请求) 代理到http://localhost:6666。如果你想要更多的代理控制行为，请查看官网说明。

parallel

默认：require('os').cpus().length > 1

是否为 Babel 或 TypeScript 使用 thread-loader。该选项在系统的 CPU 有多于一个内核时自动启用，仅作用于生产构建。

pwa
向 PWA 插件传递选项

pluginOptions
这是一个不进行任何 schema 验证的对象，因此它可以用来传递任何第三方插件选项。例如：

module.exports = {pluginOptions: {foo: {// 插件可以作为 `options.pluginOptions.foo` 访问这些选项。}}
}

常用完整配置

module.exports = {// 部署应用时的基本路径 URL，baseUrl从 Vue CLI 3.3 起，已弃用，使用publicPath来替代publicPath: process.env.NODE_ENV === 'production' ? '192.168.60.110:8080' : '192.168.60.110:8080',// build时构建文件的目录，构建时传入 --no-clean 可关闭该行为outputDir: 'dist',   // 当运行 vue-cli-service build 时生成的生产环境构建文件的目录// build时放置生成的静态资源 (js、css、img、fonts) 的 (相对于 outputDir 的) 目录assetsDir: '',// 指定生成的 index.html 的输出路径 (相对于 outputDir)。也可以是一个绝对路径。indexPath: 'index.html',// 默认在生成的静态资源文件名中包含hash以控制缓存filenameHashing: true,// 构建多页面应用，页面的配置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'},// 是否在开发环境下通过 eslint-loader 在每次保存时 lint 代码 (在生产构建时禁用 eslint-loader)lintOnSave: process.env.NODE_ENV !== 'production',// 是否使用包含运行时编译器的 Vue 构建版本runtimeCompiler: false,// Babel 显式转译列表transpileDependencies: [],// 如果你不需要生产环境的 source map，可以将其设置为 false 以加速生产环境构建productionSourceMap: true,// 设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 crossorigin 属性// （注：仅影响构建时注入的标签）crossorigin: '',// 在生成的 HTML 中的<link rel="stylesheet">和<script>标签上启用 Subresource Integrity (SRI)integrity: false,// 如果这个值是一个对象，则会通过 webpack-merge 合并到最终的配置中// 如果你需要基于环境有条件地配置行为，或者想要直接修改配置，那就换成一个函数 (该函数会在环境变量被设置之后懒执行)。该方法的第一个参数会收到已经解析好的配置。在函数内，你可以直接修改配置，或者返回一个将会被合并的对象configureWebpack: {},// 对内部的 webpack 配置（比如修改、增加Loader选项）(链式操作)chainWebpack: () =>{},// css的处理css: {// 当为true时，css文件名可省略 module 默认为 falsemodules: true,// 是否将组件中的 CSS 提取至一个独立的 CSS 文件中,当作为一个库构建时，你也可以将其设置为 false 免得用户自己导入 CSS// 默认生产环境下是 true，开发环境下是 falseextract: false,// 是否为 CSS 开启 source map。设置为 true 之后可能会影响构建的性能sourceMap: false,//向 CSS 相关的 loader 传递选项(支持 css-loader postcss-loader sass-loader less-loader stylus-loader)loaderOptions: {css: {},less: {}}},// 所有 webpack-dev-server 的选项都支持devServer: {open: true,   // 设置浏览器自动打开项目port: 8888,   // 设置端口proxy: {      // 设置代理'/api': {target: 'http://101.15.22.98',changeOrigin: true // 开启跨域// secure: true,   // 如果是https接口，需要配置这个参数}}},// 是否为 Babel 或 TypeScript 使用 thread-loaderparallel: require('os').cpus().length > 1,// 向 PWA 插件传递选项pwa: {},// 可以用来传递任何第三方插件选项pluginOptions: {}
}