Vue cli 全局配置

359 阅读3分钟

全局CLI配置

有些针对 @vue/cli 的全局配置,例如你惯用的包管理器和你本地保存的preset,都保存在home目录下一个名叫 .vuerc 的 JSON 文件。你可以用编辑器直接编辑这个文件来更改已保存的选项

你也可以使用 vue config 命令来审查或修改全局的CLI配置

vue.config.js

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

这个文件应该导出一个包含了选项的对象:

// vue.config.js
module.exports = {
    //options
}

或者,你也可以使用 @vue/cli-service 提供的 defineConfig 函数

// vue.config.js
const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
    // options
})

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应用的文件系统中。

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

    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
    

indexPath

  • Type: string

  • Default: index.html

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

pages

  • Type: Object

  • default: undefined

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

    • 一个指定了 entrytemplatefilenametitlechunks 的对象(除了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标签需要是 <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

  • Type: boolean | warning | default | error

  • Default: default

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

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