vue.config.js文件说明

// eslint-disable-next-line @typescript-eslint/no-var-requires
const CPU_NUM = require('os').cpus()
module.exports = {
  /**
   * 类型: string
   * 默认值: '/'
   * 文件访问路径，默认为绝对路径'/'(如果项目被部署到了子路径下，那么就要将其修改成'/子路径/')；也可配置为空字符串''或者相对路径'./' 打出来的包可以被部署在任意路径。
   * 注意: 极尽可能地使用绝对路径，因为在history模式下或者使用pages选项构建多页面时，会出现一些限制性条件
   */
  publicPath: '/',
  /**
   * 类型: string
   * 默认值: 'dist'
   * 打包目录: 默认每次打包的时候，会清空次此件夹中的内容，如果不想清空，请在 vue-cli-service build 执行命令后面添加 --no-clean
   * 注意: 请始终使用 outputDir 而不要修改 webpack 的 output.path。
   */
  outputDir: 'vue3.0',
  /**
   * 类型: string
   * 默认值: ''
   * 放置生成的静态资源 (js、css、img、fonts) 的 (相对于 outputDir 的) 目录。
   * 注意: 从生成的资源覆写 filename 或 chunkFilename 时，assetsDir 会被忽略。
   */
  assetsDir: '',
  /**
   * 类型: string
   * 默认值: 'index.html'
   * 指定生成的 index.html 的输出路径 (相对于 outputDir)。也可以是一个绝对路径。
   */
  indexPath: 'index.html',
  /**
   * 类型: boolean
   * 默认值: true
   * 是否给生成的静态资源文件名添加 hash
   * 注意: 要求 index 的 HTML 是被 Vue CLI 自动生成的。如果你无法使用 Vue CLI 生成的 index HTML，你可以通过将这个选项设为 false 来关闭文件名哈希。
   */
  filenameHashing: true,
  /**
   * 类型: object
   * 默认值: undefined
   * 在 multi-page 模式下构建应用。每个 'page' 应该有一个对应的 JavaScript 入口文件。其值应该是一个对象，对象的 key 是入口的名字，value 是:
   * a) 一个指定了 entry, template, filename, title 和 chunks 的对象 (除了 entry 之外都是可选的)；
   * b) 或一个指定其 entry 的字符串。
   * 注意: 当在 multi-page 模式下构建时，webpack 配置会包含不一样的插件 (这时会存在多个 html-webpack-plugin 和 preload-webpack-plugin 的实例)。如果你试图修改这些插件的选项，请确认运行 vue inspect。
   */
  // pages: {
  //   /**
  //    * type: string | object
  //    * entry: 子页面入口文件
  //    * template: 模板来源
  //    * filename: 在 dist/index.html 的输出
  //    * title: template 中的 title 标签需要是 <title><%= htmlWebpackPlugin.options.title %></title>
  //    * chunks: 在这个页面中包含的块，默认情况下会包含提取出来的通用 chunk 和 vendor chunk。
  //    */
  //   index: {
  //     entry: 'src/index/main.js',
  //     template: 'public/index.html',
  //     filename: 'index.html',
  //     title: 'Index Page',
  //     chunks: ['chunk-vendors', 'chunk-common', 'index']
  //   },
  //   /**
  //    * 当使用只有入口的字符串格式时，模板会被推导为 `public/subpage.html`，并且如果找不到的话，就回退到 `public/index.html`。
  //    * 输出文件名会被推导为 `subpage.html`。
  //    */
  //   subpage: 'src/subpage/main.js'
  // },
  /**
   * 类型: boolean | 'warning' | 'default' | 'error'
   * 默认值: 'default'
   * 是否在开发环境下通过 eslint-loader 在每次保存时 lint 代码。这个值会在 @vue/cli-plugin-eslint 被安装之后生效
   * a) 设置为 true 或 'warning' 时，eslint-loader 会将 lint 错误输出为编译警告。默认情况下，警告仅仅会被输出到命令行，且不会使得编译失败。
   * b) 如果你希望让 lint 错误在开发时直接显示在浏览器中，你可以使用 lintOnSave: 'default'。这会强制 eslint-loader 将 lint 错误输出为编译错误，同时也意味着 lint 错误将会导致编译失败。
   * c) 设置为 error 将会使得 eslint-loader 把 lint 警告也输出为编译错误，这意味着 lint 警告将会导致编译失败。
   * d) 通过设置让浏览器 overlay 同时显示警告和错误
   *  module.exports = {
        devServer: {
          overlay: {
            warnings: true,
            errors: true
          }
        }
      }
   * 注意: 当 lintOnSave 是一个 truthy 的值时，eslint-loader 在开发和生产构建下都会被启用
   */
  lintOnSave: 'default',
  /**
   * 类型: boolean
   * 默认值: false
   * 是否使用包含运行时编译器的 Vue 构建版本。设置为 true 后可以在 Vue 组件中使用 template 选项了，但是这会让应用额外增加 10kb 左右。
   */
  runtimeCompiler: false,
  /**
   * 类型: Array<string | RegExp>
   * 默认值: []
   * 默认情况下 babel-loader 会忽略所有 node_modules 中的文件。如果你想要通过 Babel 显式转译一个依赖，可以在这个选项中列出来。
   */
  transpileDependencies: [],
  /**
   * 类型: boolean
   * 默认值: true
   * 如果你不需要生产环境的 source map，可以将其设置为 false 以加速生产环境构建。
   */
  productionSourceMap: false,
  /**
   * 类型: string
   * 默认值: undefined
   * 设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 crossorigin 属性。
   * 注意: 该选项仅影响由 html-webpack-plugin 在构建时注入的标签 - 直接写在模版 (public/index.html) 中的标签不受影响。
   */
  crossorigin: undefined,
  /**
   * 类型: boolean
   * 默认值: false
   * 在生成的 HTML 中的 <link rel="stylesheet"> 和 <script> 标签上启用 Subresource Integrity (SRI)。如果你构建后的文件是部署在 CDN 上的，启用该选项可以提供额外的安全性。
   * 注意: 该选项仅影响由 html-webpack-plugin 在构建时注入的标签 - 直接写在模版 (public/index.html) 中的标签不受影响。当启用 SRI 时，preload resource hints 会被禁用，因为 Chrome 的一个 bug 会导致文件被下载两次。
   */
  integrity: false,
  /**
   * 类型: object | function
   * 默认值: 无
   * a) 如果这个值是一个对象，则会通过 webpack-merge 合并到最终的配置中。
   * b) 如果这个值是一个函数，则会接收被解析的配置作为参数。该函数既可以修改配置并不返回任何东西，也可以返回一个被克隆或合并过的配置版本。
   * 配置详情请参考: https://cli.vuejs.org/zh/guide/webpack.html#%E7%AE%80%E5%8D%95%E7%9A%84%E9%85%8D%E7%BD%AE%E6%96%B9%E5%BC%8F
   */
  // configureWebpack: config => {},
  /**
   * 类型: function
   * 默认值: 无
   * 接收一个基于 webpack-chain 的 ChainableConfig 实例。允许对内部的 webpack 配置进行更细粒度的修改。
   * 配置详情请参考: https://cli.vuejs.org/zh/guide/webpack.html#%E9%93%BE%E5%BC%8F%E6%93%8D%E4%BD%9C-%E9%AB%98%E7%BA%A7
   */
  // chainWebpack: config => {},
  /**
   * 类型: object
   * 默认值: {}
   * 样式文件的相关配置
   */
  css: {
    /**
     * 类型: boolean
     * 默认值: 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 文件中。
     */
    requireModuleExtension: true,
    /**
     * 类型: boolean | object
     * 默认值: 生产环境下是 true，开发环境下是 false
     * 是否将组件中的 CSS 提取至一个独立的 CSS 文件中 (而不是动态注入到 JavaScript 中的 inline 代码)。
     * 同样当构建 Web Components 组件时它总是会被禁用 (样式是 inline 的并注入到了 shadowRoot 中)。
     * 当作为一个库构建时，可以将其设置为 false 免得用户自己导入 CSS。
     * 注意: 提取 CSS 在开发环境模式下是默认不开启的，因为它和 CSS 热重载不兼容。然而，你仍然可以将这个值显性地设置为 true 在所有情况下都强制提取。
     */
    extract: process.env.NODE_ENV === 'production',
    /**
     * 类型: boolean
     * 默认值: false
     * 是否为 CSS 开启 source map。设置为 true 之后可能会影响构建的性能。
     */
    sourceMap: false,
    /**
     * 类型: object
     * 默认值: {}
     * 样式 loader 配置项
     * 支持配置的 loader 有：
     * css-loader | postcss-loader | sass-loader | less-loader | stylus-loader
     * 注意: 也可以使用 scss 选项，针对 scss 语法进行单独配置（区别于 sass 语法）。相比于使用 chainWebpack 手动指定 loader 更推荐上面这样做，因为这些选项需要应用在使用了相应 loader 的多个地方。
     */
    loaderOptions: {
      //   css: {
      //     // 这里的选项会传递给 css-loader
      //   },
      //   postcss: {
      //     // 这里的选项会传递给 postcss-loader
      //   }
    }
  },
  /**
   * 类型: object
   * 默认值: {}
   * 所有 webpack-dev-server 的选项都支持
   * 注意: 有些值像 host、port 和 https 可能会被命令行参数覆写。有些值像 publicPath 和 historyApiFallback 不应该被修改，因为它们需要和开发服务器的 publicPath 同步以保障正常的工作。
   * 配置详情请参考: https://webpack.js.org/configuration/dev-server/
   */
  devServer: {
    /**
     * 类型: string | object
     * 默认值: 无
     * 当值为某一个绝对路径时，开发服务器将任何未知请求 (没有匹配到静态文件的请求) 代理到此处的绝对路径
     * 如果要配置多个代理，那么将 proxy 定义为一个对象，进行相关配置，详情配置请参考: https://github.com/chimurai/http-proxy-middleware#proxycontext-config
     */
    proxy: {
      '/api': {
        target: 'localhost:8001',
        ws: true,
        changeOrigin: true
      }
    }
  },
  /**
   * 类型: boolean
   * 默认值: require('os').cpus().length > 1
   * 是否为 Babel 或 TypeScript 使用 thread-loader。该选项在系统的 CPU 有多于一个内核时自动启用，仅作用于生产构建。
   */
  parallel: CPU_NUM.length > 1
  /**
   * 类型: string | object
   * 默认值: 无
   * PWA（Progressive Web App）是一种理念，使用多种技术来增强web app的功能，可以让网站的体验变得更好，能够模拟一些原生功能，比如通知推送。
   * PWA 插件传递选项，详情配置请参考: https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-pwa
   * 注意: 仅在生产环境中启用
   */
  //   pwa: {}
}