vue.config.js是一个可选的配置文件。一般在项目的根目录下,和package.json同级。
某个配置文档
string
'/'
项目打包之后在项目中存放的路径,默认值为:‘/’,如果要特定的放在某个目录下,需要通过该参数设置。
默认情况下,Vue CLI 会假设你的应用是被部署在一个域名的根路径上,例如 https://www.my-app.com/
。
如果应用被部署在一个子路径上,你就需要用这个选项指定这个子路径。例如,如果你的应用被部署在 https://www.my-app.com/my-app/
,则设置 publicPath
为 /my-app/
。
这个值也可以被设置为空字符串 (''
) 或是相对路径 ('./'
),这样所有的资源都会被链接为相对路径,这样打出来的包可以被部署在任意路径
string
'dist'
项目打包完之后的包名,默认命名为:‘dist’,如果需要指定打包的包名,那么就需要使用该参数进行设定。
当运行 vue-cli-service build
时生成的生产环境构建文件的目录。
注意目标目录的内容在构建之前会被清除 (构建时传入 --no-clean
可关闭该行为)。也就是每次打包之前,都会清空该路径指向的目录,用来装新的打包之后的包
**注意:**请始终使用 outputDir
而不要修改 webpack 的 output.path
。
string
''
在打包之后的包中存放静态资源的文件目录,在打包之后的包中的目录
放置生成的静态资源 (js、css、img、fonts) 的 (相对于 outputDir
的) 目录。
**注意:**从生成的资源覆写 filename 或 chunkFilename 时,assetsDir
会被忽略。
string
'index.html'
打包的包(dist)中的index.html文件的目录,默认就是dist的下一级,也就是打包之后的包的根目录。
指定生成的 index.html
的输出路径 (相对于 outputDir
)。也可以是一个绝对路径。
boolean
true
默认情况下,生成的静态资源在它们的文件名中包含了 hash 以便更好的控制缓存。然而,这也要求 index 的 HTML 是被 Vue CLI 自动生成的。如果你无法使用 Vue CLI 生成的 index HTML,你可以通过将这个选项设为 false
来关闭文件名哈希。
通俗的理解:
执行 npm run build 之后的 dist 目录的静态资源的文件名多会追加上 hash 值,比如: page1.f151b4d3.js
那如果不要 hash 呢,你只需要配置 vue.config.js 文件中的 filenamehashing
官方文档也提到了因为 html 也是我们通过插件生成的,静态资源直接就 inject 进去的,所以,当 html 不是自动生成或者其他情况时候,就不能加 hash 了,可以配置 false。
Object
undefined
在 multi-page 模式下构建应用。每个“page”应该有一个对应的 JavaScript 入口文件。其值应该是一个对象,对象的 key 是入口的名字,value 是:
entry
, template
, filename
, title
和 chunks
的对象 (除了 entry
之外都是可选的);entry
的字符串。module.exports = {
pages: {
index: {
// page 的入口
entry: 'src/index/main.js',
// 模板来源
template: 'public/index.html',
// 在 dist/index.html 的输出
filename: 'index.html',
// 当使用 title 选项时,
// template 中的 title 标签需要是 <%= htmlWebpackPlugin.options.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'
}
}
范例:
vue.config.js文件是Vue CLI的配置文件,其中的pages配置项用来配置多页面应用。
pages配置项是一个对象,其中的key题面的路径, value 题面的入口文件。例如:
module.exports = {
pages: {
index: {
entry:'src/ index/main.js ',
template: 'public/index.html',
filename: 'index. html'.
},
about: {
entry: 'src/about/main.js',
template: 'public/about.html',
filename:'about.html',
},
},
};
这样配置后,Vue CLI会自动生成两个页面,分别是/index和/about,其中index页面的入口文件是src/index/main.js,模板文件是public/index.html,生成的文件名是index html。
boolean
| 'warning'
| 'default'
| 'error'
'default'
d
是否在开发环境下通过 eslint-loader 在每次保存时 lint 代码。这个值会在 @vue/cli-plugin-eslint
被安装之后生效。
用途
设置是否在开发环境下每次保存代码时都启用 eslint验证。
value:
false:关闭每次保存都进行检测
true:开启每次保存都进行检测,效果与warning一样
‘warning’:开启每次保存都进行检测,lint 错误将显示到控制台命令行,而且编译并不会失败。
‘error’:开启每次保存都进行检测,lint 错误将显示到浏览器页面上,且编译失败。
‘default’:同’error’
用法:
module.exports = {
publicPath: './', // 基本路径
outputDir: 'dist', // 输出文件目录
assetsDir: './assets',
indexPath: 'index.html',
filenameHashing: true, // 生成的静态资源在它们的文件名中包含了 hash 以便更好的控制缓存
lintOnSave: false, // eslint-loader 是否在保存的时候检查
}
boolean
false
是否使用包含运行时编译器的 Vue 构建版本。设置为 true
后你就可以在 Vue 组件中使用 template
选项了,但是这会让你的应用额外增加 10kb 左右。
boolean | Array
false
默认情况下 babel-loader
会忽略所有 node_modules
中的文件。你可以启用本选项,以避免构建后的代码中出现未转译的第三方依赖。
不过,对所有的依赖都进行转译可能会降低构建速度。如果对构建性能有所顾虑,你可以只转译部分特定的依赖:给本选项传一个数组,列出需要转译的第三方包包名或正则表达式即可。
处理兼容性问题
const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
// node_modules里的依赖默认是不会编译的,会导致es6语法在ie中的语法报错,
// 所以需要在vue.config.js中使用transpileDependencies属性配置node_modules
// 中指定哪些文件夹或文件需要编译.
transpileDependencies: true
//true的时候是全部编译
})
boolean
true
如果你不需要生产环境的 source map,可以将其设置为 false
以加速生产环境构建。
每个文件打包后都会出现一个.map文件,.map文件会出现一定的网络安全问题,我们可以通过productionSourceMap进行操作,使打包的文件不在出现.map文件,打包后的文件体积也会减少。
string
undefined
设置生成的 HTML 中 和
标签的
crossorigin
属性。
需要注意的是该选项仅影响由 html-webpack-plugin
在构建时注入的标签 - 直接写在模版 (public/index.html
) 中的标签不受影响。
使用的比较少一般不用去设置
boolean
false
在生成的 HTML 中的 和
标签上启用 Subresource Integrity (SRI)。如果你构建后的文件是部署在 CDN 上的,启用该选项可以提供额外的安全性。
需要注意的是该选项仅影响由 html-webpack-plugin
在构建时注入的标签 - 直接写在模版 (public/index.html
) 中的标签不受影响。
另外,当启用 SRI 时,preload resource hints 会被禁用,因为 Chrome 的一个 bug 会导致文件被下载两次。
Type: Object | Function
ConfigureWebpack是一个可选的属性,用于配置Vue CLI生成的webpack配置。通过使用ConfigureWebpack,我们可以轻松地自定义我们的webpack配置。
如果这个值是一个对象,则会通过 webpack-merge 合并到最终的配置中。
如果这个值是一个函数,则会接收被解析的配置作为参数。该函数既可以修改配置并不返回任何东西,也可以返回一个被克隆或合并过的配置版本。
Type: Function
是一个函数,会接收一个基于 webpack-chain 的 ChainableConfig
实例。允许对内部的 webpack 配置进行更细粒度的修改。
相关博客
Type: boolean
Default: true
默认情况下,只有 *.module.[ext]
结尾的文件才会被视作 CSS Modules 模块。设置为 false
后你就可以去掉文件名中的 .module
并将所有的 *.(css|scss|sass|less|styl(us)?)
文件视为 CSS Modules 模块。
Type: boolean | Object
Default: 生产环境下是 true
,开发环境下是 false
是否将组件中的 CSS 提取至一个独立的 CSS 文件中 (而不是动态注入到 JavaScript 中的 inline 代码)。
同样当构建 Web Components 组件时它总是会被禁用 (样式是 inline 的并注入到了 shadowRoot 中)。
当作为一个库构建时,你也可以将其设置为 false
免得用户自己导入 CSS。
提取 CSS 在开发环境模式下是默认不开启的,因为它和 CSS 热重载不兼容。然而,你仍然可以将这个值显性地设置为 true
在所有情况下都强制提取。
Type: boolean
Default: false
是否为 CSS 开启 source map。设置为 true
之后可能会影响构建的性能。
Type: Object
Default: {}
向 CSS 相关的 loader 传递选项。例如:
module.exports = {
css: {
loaderOptions: {
css: {
// 这里的选项会传递给 css-loader
},
postcss: {
// 这里的选项会传递给 postcss-loader
}
}
}
}
Type: Object
所有 webpack-dev-server
的选项都支持。注意:
host
、port
和 https
可能会被命令行参数覆写。publicPath
和 historyApiFallback
不应该被修改,因为它们需要和开发服务器的 publicPath 同步以保障正常的工作。热更新
module.exports = {
devServer: {
port: port,
open: true,
overlay: {
warnings: false,
errors: true
},
before: require('./mock/mock-server.js')
}
}
Type: string | Object
用于前后端交互,解决同源策略问题
如果你的前端应用和后端 API 服务器没有运行在同一个主机上,你需要在开发环境下将 API 请求代理到 API 服务器。这个问题可以通过 vue.config.js
中的 devServer.proxy
选项来配置。
devServer.proxy
可以是一个指向开发环境 API 服务器的字符串:
module.exports = {
devServer: {
proxy: 'http://localhost:4000'
}
}
这会告诉开发服务器将任何未知请求 (没有匹配到静态文件的请求) 代理到http://localhost:4000
。
如果你想要更多的代理控制行为,也可以使用一个 path: options
成对的对象。
module.exports = {
devServer: {
proxy: {
'/api': {
target: '' ,
ws: true,
changeOrigin: true
},
'/foo': {
target: ''
}
}
}
}
Type: boolean
Default: require('os').cpus().length > 1
是否为 Babel 或 TypeScript 使用 thread-loader
。该选项在系统的 CPU 有多于一个内核时自动启用,仅作用于生产构建。
Type: Object
向 PWA 插件传递选项。
Type: Object
这是一个不进行任何 schema 验证的对象,因此它可以用来传递任何第三方插件选项。例如:
module.exports = {
pluginOptions: {
foo: {
// 插件可以作为 `options.pluginOptions.foo` 访问这些选项。
}
}
}