vue 配置文件 vue.config.js

vue-config-js 官网简介

vue.config.js 简介

vue-cli 脚手架搭建完成后，项目目录中没有 vue.config.js 文件，需要手动创建。

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

vue.config.js 配置

在根目录中创建 vue.config.js，这个文件应该导出一个包含了选项的对象：

1
2
3
module.exports = {
  // 选项...
}

或者也可以使用 @vue/cli-service 提供的 defineConfig 帮手函数，以获得更好的类型提示：

1
2
3
4
5
6
// `vue.config.js`
const { defineConfig } = require('@vue/cli-service')

module.exports = defineConfig({
  // 选项
})

配置选项

baseUrl

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

publicPath

  • Type: string

  • Default: '/'

    部署应用包时的基本 URL。用法和 webpack 本身的 output.publicPath 一致，但是 Vue CLI 在一些其他地方也需要用到这个值，所以**请始终使用 publicPath 而不要直接修改 webpack 的 output.publicPath**。

    默认情况下，Vue CLI 会假设你的应用是被部署在一个域名的根路径上，例如 https://www.my-app.com/。如果应用被部署在一个子路径上，你就需要用这个选项指定这个子路径。例如，如果你的应用被部署在 https://www.my-app.com/my-app/，则设置 publicPath 为 /my-app/。

    这个值也可以被设置为空字符串 ('') 或是相对路径 ('./')，这样所有的资源都会被链接为相对路径，这样打出来的包可以被部署在任意路径，也可以用在类似 Cordova hybrid 应用的文件系统中。

    相对 publicPath 的限制

    相对路径的 publicPath 有一些使用上的限制。在以下情况下，应当避免使用相对 publicPath:

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

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

    这个值在开发环境下同样生效。如果你想把开发服务器架设在根路径，你可以使用一个条件式的值：

    1
    2
    3
    4
    5
    module.exports = {
      publicPath: process.env.NODE_ENV === 'production'
        ? '/production-sub-path/'
        : '/'
    }

outputDir

  • Type: string

  • Default: 'dist'

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

    提示

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

assetsDir

  • Type: string

  • Default: ''

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

    提示

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

indexPath

  • Type: string

  • Default: 'index.html'

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

filenameHashing

  • Type: boolean

  • Default: true

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

pages ☆☆☆

  • Type: Object

  • Default: undefined

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

    • 一个指定了 entry, template, filename, title 和 chunks 的对象 (除了 entry 之外都是可选的)；
    • 或一个指定其 entry 的字符串。
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    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'
      }
    }

    提示：当在 multi-page 模式下构建时，webpack 配置会包含不一样的插件 (这时会存在多个 html-webpack-plugin 和 preload-webpack-plugin 的实例)。如果你试图修改这些插件的选项，请确认运行 vue inspect。

lintOnSave ☆☆☆

  • Type: boolean | 'warning' | 'default' | 'error'

  • Default: 'default'

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

    设置为 true 或 'warning' 时，eslint-loader 会将 lint 错误输出为编译警告。默认情况下，警告仅仅会被输出到命令行，且不会使得编译失败。

    如果你希望让 lint 错误在开发时直接显示在浏览器中，你可以使用 lintOnSave: 'default'。这会强制 eslint-loader 将 lint 错误输出为编译错误，同时也意味着 lint 错误将会导致编译失败。

    设置为 error 将会使得 eslint-loader 把 lint 警告也输出为编译错误，这意味着 lint 警告将会导致编译失败。

    或者，你也可以通过设置让浏览器 overlay 同时显示警告和错误：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    // `vue.config.js`
    module.exports = {
      devServer: {
        overlay: {
          warnings: true,
          errors: true
        }
      }
    }

    当 lintOnSave 是一个 truthy 的值时，eslint-loader 在开发和生产构建下都会被启用。如果你想要在生产构建时禁用 eslint-loader，你可以用如下配置：

    1
    2
    3
    4
    // `vue.config.js`
    module.exports = {
      lintOnSave: process.env.NODE_ENV !== 'production'
    }

runtimeCompiler

  • Type: boolean

  • Default: false

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

    更多细节可查阅：Runtime + Compiler vs. Runtime only。

transpileDependencies

  • Type: boolean | Array<string | RegExp>

  • Default: false

    默认情况下 babel-loader 会忽略所有 node_modules 中的文件。你可以启用本选项，以避免构建后的代码中出现未转译的第三方依赖。

    不过，对所有的依赖都进行转译可能会降低构建速度。如果对构建性能有所顾虑，你可以只转译部分特定的依赖：给本选项传一个数组，列出需要转译的第三方包包名或正则表达式即可。

productionSourceMap ☆☆☆

  • Type: boolean

  • Default: true

运行：npm run build 之后会生成一个 dist 文件夹，里面有两种文件：一种是正常的 .js 文件，另一种是以 .map 文件结尾的，.map文件可以指出哪里报错。

项目打包之后，代码都是经过压缩加密的，如果运行报错，输出的错误信息无法准确得知是哪里的代码报错，有了.map文件就可以像未加密的代码一样，准确的输出是哪一行哪一列有错，但是.map文件通常比较大，如果不需要这个文件可以去掉

如果想在打包的时候不生出 .map 文件， 在vue.config.js文件中配置 productionSourceMap:false

crossorigin #

  • Type: string

  • Default: undefined

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

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

    更多细节可查阅: CORS settings attributes

integrity

  • Type: boolean

  • Default: false

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

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

    另外，当启用 SRI 时，preload resource hints 会被禁用，因为 Chrome 的一个 bug 会导致文件被下载两次。

configureWebpack ☆☆☆

  • Type: Object | Function

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

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

    更多细节可查阅：配合 webpack > 简单的配置方式

chainWebpack

  • Type: Function

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

    更多细节可查阅：配合 webpack > 链式操作

css.modules

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

css.requireModuleExtension

  • Type: boolean

  • Default: 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 > CSS Modules

css.extract

  • Type: boolean | Object

  • Default: 生产环境下是 true，开发环境下是 false

    是否将组件中的 CSS 提取至一个独立的 CSS 文件中 (而不是动态注入到 JavaScript 中的 inline 代码)。

    同样当构建 Web Components 组件时它总是会被禁用 (样式是 inline 的并注入到了 shadowRoot 中)。

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

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

css.sourceMap

  • Type: boolean

  • Default: false

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

css.loaderOptions

  • Type: Object

  • Default: {}

    向 CSS 相关的 loader 传递选项。例如：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    module.exports = {
      css: {
        loaderOptions: {
          css: {
            // 这里的选项会传递给 css-loader
          },
          postcss: {
            // 这里的选项会传递给 postcss-loader
          }
        }
      }
    }

    支持的 loader 有：

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

    更多细节可查阅：向预处理器 Loader 传递选项

    提示

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

devServer ☆☆☆

  • Type: Object

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

    • 有些值像 host、port 和 https 可能会被命令行参数覆写。

    • 有些值像 publicPath 和 historyApiFallback 不应该被修改，因为它们需要和开发服务器的 publicPath 同步以保障正常的工作。

  • 示例

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    devServer: {
        // development server port 8000
        port: 8000,
        proxy: {
            '/api/wristband': {
                target: 'http://172.xx.xxx.xx:8080/',     // 拦截到'api/wristband'的，将axios中baseURL替换成target
                ws: true,                                 // proxy websockets
                changeOrigin: true,                       // 是否跨域
                // pathRewrite: {                         // 重写，根据需要
                //   '^/api/oldpath': '/api/newpath', 
                // }
            },
        }
    }

devServer.proxy

  • Type: string | Object

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

    devServer.proxy 可以是一个指向开发环境 API 服务器的字符串：

    1
    2
    3
    4
    5
    module.exports = {
      devServer: {
        proxy: 'http://localhost:4000'
      }
    }

    这会告诉开发服务器将任何未知请求 (没有匹配到静态文件的请求) 代理到http://localhost:4000。

    如果你想要更多的代理控制行为，也可以使用一个 path: options 成对的对象。完整的选项可以查阅 http-proxy-middleware 。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    module.exports = {
      devServer: {
        proxy: {
          '/api': {
            target: '<url>',
            ws: true,
            changeOrigin: true
          },
          '/foo': {
            target: '<other_url>'
          }
        }
      }
    }

parallel

  • Type: boolean

  • Default: require('os').cpus().length > 1

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

pwa

pluginOptions

  • Type: Object

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

    1
    2
    3
    4
    5
    6
    7
    module.exports = {
      pluginOptions: {
        foo: {
          // 插件可以作为 `options.pluginOptions.foo` 访问这些选项。
        }
      }
    }

Babel

Babel 可以通过 babel.config.js 进行配置。

TIP

Vue CLI 使用了 Babel 7 中的新配置格式 babel.config.js。和 .babelrc 或 package.json 中的 babel 字段不同，这个配置文件不会使用基于文件位置的方案，而是会一致地运用到项目根目录以下的所有文件，包括 node_modules 内部的依赖。我们推荐在 Vue CLI 项目中始终使用 babel.config.js 取代其它格式。

所有的 Vue CLI 应用都使用 @vue/babel-preset-app，它包含了 babel-preset-env、JSX 支持以及为最小化包体积优化过的配置。通过它的文档可以查阅到更多细节和 preset 选项。

同时查阅指南中的 Polyfill 章节。

ESLint

ESLint 可以通过 .eslintrc 或 package.json 中的 eslintConfig 字段来配置。

更多细节可查阅 @vue/cli-plugin-eslint。

TypeScript

TypeScript 可以通过 tsconfig.json 来配置。

更多细节可查阅 @vue/cli-plugin-typescript。

单元测试

Jest

更多细节可查阅 @vue/cli-plugin-unit-jest。

Mocha (配合 mocha-webpack) #

更多细节可查阅 @vue/cli-plugin-unit-mocha。

E2E 测试

Cypress

更多细节可查阅 @vue/cli-plugin-e2e-cypress。

Nightwatch #

更多细节可查阅 @vue/cli-plugin-e2e-nightwatch。

vue.config.js 配置选项 示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
// `vue.config.js` 配置选项

module.exports = {

    // 选项
    //  基本路径
    publicPath: "./",
    
    //  构建时的输出目录
    outputDir: "dist",

    //  放置静态资源的目录
    assetsDir: "static",

    //  html 的输出路径
    indexPath: "index.html",

    //文件名哈希
    filenameHashing: true,

    //用于多页配置，默认是 undefined
    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` 进行检查。
    lintOnSave: true,

    //  是否使用带有浏览器内编译器的完整构建版本
    runtimeCompiler: false,

    //  babel-loader 默认会跳过 node_modules 依赖。
    transpileDependencies: [ /* string or regex */ ],

    //  是否为生产环境构建生成 source map？
    productionSourceMap: true,

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

    //  在生成的 HTML 中的 <link rel="stylesheet"> 和 <script> 标签上启用 Subresource Integrity (SRI)。
    integrity: false,

    //  调整内部的 webpack 配置
    configureWebpack: () => {}, //(Object | Function)
    chainWebpack: () => {},

    // 配置 webpack-dev-server 行为。
    devServer: {
        open: process.platform === 'darwin',
        host: '0.0.0.0',
        port: 8080,
        https: false,
        hotOnly: false,
        // 查阅 https://github.com/vuejs/vue-docs-zh-cn/blob/master/vue-cli/cli-service.md#配置代理
        proxy: {
            '/api': {
                target: "http://app.rmsdmedia.com",
                changeOrigin: true,
                secure: false,
                pathRewrite: {
                    "^/api": ""
                }
            },
            '/foo': {
                target: '<other_url>'
            }

        }, // string | Object
        before: app => {}
    },

    // CSS 相关选项
    css: {
        // 将组件内的 CSS 提取到一个单独的 CSS 文件 (只用在生产环境中)
        // 也可以是一个传递给 `extract-text-webpack-plugin` 的选项对象
        extract: true,
        
        // 是否开启 CSS source map？
        sourceMap: false,

        // 为预处理器的 loader 传递自定义选项。比如传递给
        // Css-loader 时，使用 `{ Css: { ... } }`。
        loaderOptions: {
            css: {
                // 这里的选项会传递给 css-loader
            },

            postcss: {
                // 这里的选项会传递给 postcss-loader
            }

        },

        // 为所有的 CSS 及其预处理文件开启 CSS Modules。
        // 这个选项不会影响 `*.vue` 文件。
        modules: false
    },

    // 在生产环境下为 Babel 和 TypeScript 使用 `thread-loader`
    // 在多核机器下会默认开启。
    parallel: require('os').cpus().length > 1,

    // PWA 插件的选项。
    // 查阅 https://github.com/vuejs/vue-docs-zh-cn/blob/master/vue-cli-plugin-pwa/README.md
    pwa: {},

    // 三方插件的选项
    pluginOptions: {
        // ...
    }
}
Vue
#Vue
vue 配置文件 vue.config.js
https://flepeng.github.io/021-frontend-04-Vue-vue-配置文件-vue-config-js/
作者
Lepeng
发布于
2021年8月11日
许可协议