当前位置：网站首页>config.js related configuration summary

config.js related configuration summary

2022-08-05 06:32:00 【MoXinXueWEB】

序：

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

文件位置：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xlk69YZC-1654509260792)(C:\Users\huawei\AppData\Roaming\Typora\typora-user-images\image-20220606151621322.png)]$

Common configuration code：

module.exports = {
    
  // 执行 npm run build 统一配置文件路径（本地访问dist/index.html需'./'）
  // publicPath: './',
  // NODE_ENV：Node.js 暴露给执行脚本的系统环境变量.通常用于确定在开发环境还是生产环境
  publicPath: process.env.NODE_ENV === 'production' ? '' : '/',
  // 输出文件目录
  outputDir: `dist/Doc`,
  // 放置静态资源
  // assetsDir: 'static',
  // 设置是否在开发环境下每次保存代码时都启用 eslint验证
  lintOnSave: false,
  // 文件命名,生成的静态资源在它们的文件名中包含了 hash 以便更好的控制缓存
  // filenameHashing: true,
  // 运行时版本是否需要编译
  // runtimeCompiler: false,
  configureWebpack: {
    
    // 别名配置
    resolve: {
    
      alias: {
    
        //'src': '@', 默认已配置
        'assets': '@/assets',
        'common': '@/common',
        'components': '@/components',
        'api': '@/api',
        'views': '@/views',
        'plugins': '@/plugins',
        'utils': '@/utils',
      }
    }
    // 使用前面可加~
  },
  productionSourceMap: false, //如果你不需要生产环境的 source map,可以将其设置为 false 以加速生产环境构建
  // css相关配置
  css: {
    
    // 是否将组件中的 CSS 提取至一个独立的 CSS 文件中,生产环境下是 true,开发环境下是 false
    extract: process.env.NODE_ENV === "production",
    // 是否为 CSS 开启 source map.设置为 true 之后可能会影响构建的性能.
    sourceMap: false,
    // 启用 CSS modules for all css / pre-processor files.(预加载)
    requireModuleExtension: true,
    loaderOptions: {
    
      sass: {
    
        // data: `@import "@/assets/css/variables.scss";`
      }
    }
  },
  // 解决本地跨域
  devServer: {
    
    // proxy: (() => {
    
         // let obj = {};
         // let apiArr = [
             // '/L001Q','/L002Q'
         // ];
         // apiArr.forEach(item => {
    
           // obj[item] = {
    
               // target: 'http://128.224.202.178:6112' + item,
               // changeOrigin: true,
               // pathRewrite: {
    
                 // [item] : ''
             // }
           // }
		// })
        // return obj
     // })()
    proxy: {
    
      '/L001Q': {
    
        target: 'http://128.224.202.178:6112/',
        changeOrigin: true,
      }
    }
  }
}

Basic configuration details

publicPath

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

outputDir

打包完成后,The directory where the build files are placed.默认为dist

assetsDir

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

indexPath

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

filenameHashing

Whether to turn off filename hashing.On by default

pages

在 multi-page（多页）模式下构建应用.每个“page”应该有一个对应的 JavaScript 入口文件.

  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'
  }

**注：**当在多页应用模式下构建时,webpack 配置会包含不一样的插件 (这时会存在多个html-webpack-plugin和preload-webpack-plugin的实例).如果你试图修改这些插件的选项,请确认运行vue inspect.

lintOnSave

Whether to use when saving eslint-loader 进行检查.取值 boolean | 'warning' | 'default' | 'error' 可以配置ESlint的报错

runtimeCompiler

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

transpileDependencies

默认情况下 babel-loader 会忽略所有 node_modules 中的文件.如果你想要通过 Babel 显式转译一个依赖,可以在这个选项中列出来.It may be useful to deal with some compatibility issues

productionSourceMap

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

crossorigin

设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 crossorigin 属性.
crossoriginGet error information for cross-domain scripting
**注意：**This option only affects by html-webpack-plugin 在构建时注入的标签 - 直接写在模版 (public/index.html) 中的标签不受影响.

integrity

设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 integrity 属性.
Validate the resource完整性
**注意：**This option only affects by html-webpack-plugin 在构建时注入的标签 - 直接写在模版 (public/index.html) 中的标签不受影响.

WebpackDetailed configuration

configureWebpack

如果这个值是一个对象,则会通过webpack-merge合并到最终的配置中.
如果这个值是一个函数,则会接收被解析的配置作为参数.该函数及可以修改配置并不返回任何东西,也可以返回一个被克隆或合并过的配置版本.

chainWebpack

通过 webpack-chainmaintenance configuration.Allows finer-grained control over internal configuration.

修改某些Loader选项
添加新的Loader
替换loader
修改插件选项

CSSDetailed configuration

css.modules(===css.requireModuleExtension)

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

extract

是否将组件中的 CSS 提取至一个独立的 CSS 文件中,Default: 生产环境下是 true,开发环境下是 false

sourceMap

是否为 CSS 开启 source map. 默认为 false

loaderOptions

向 CSS 相关的 loader 传递选项

支持的有：css-loader、postcss-loader、sass-loader、less-loader、stylus-loader

devServer

Your front-end application and back-end API 服务器没有运行在同一个主机上,你需要在开发环境下将 API 请求代理到 API 服务器.这个问题可以通过vue.config.js中的devServer.proxy选项来配置.

// webpack-dev-server 相关配置
devServer: {
    
    open: false, //open 在devServer启动且第一次构建完成时,自动用我们的系统的默认浏览器去打开要开发的网页
    host: '0.0.0.0', //默认是 localhost.如果你希望服务器外部可访问,指定如下 host: '0.0.0.0',设置之后之后可以访问ip地址
    port: 8080,
    hot: true, //hot配置是否启用模块的热替换功能,devServer的默认行为是在发现源代码被变更后,通过自动刷新整个页面来做到事实预览,开启hot后,将在不刷新整个页面的情况下通过新模块替换老模块来做到实时预览.
    https: false,
    hotOnly: false, // hot 和 hotOnly 的区别是在某些模块不支持热更新的情况下,前者会自动刷新页面,后者不会刷新页面,而是在控制台输出热更新失败
    proxy: {
    
      '/': {
    
        target: 'http://xxxx:8080', //目标接口域名
        secure: false, //false为http访问,true为https访问
        changeOrigin: true, //是否跨域
        pathRewrite: {
    
          '^/': '/' //重写接口
        }
      }
    }, // 设置代理
    before: app => {
     }
  }

parallel

是否为 Babel 或 TypeScript 使用 thread-loader

pwa

渐进式 Web 应用会 Installables are available on desktop and mobile、App-like experience,可直接通过 Web Build and deliver.它们是快速、可靠的 Web 应用.最重要的是,They are available for any browser Web 应用.
This option is passed topwaSome configuration items of the plugin

  pwa: {
    
    name: 'My App',
    themeColor: '#4DBA87',
    msTileColor: '#000000',
    appleMobileWebAppCapable: 'yes',
    appleMobileWebAppStatusBarStyle: 'black',

    // configure the workbox plugin
    workboxPluginMode: 'InjectManifest',
    workboxOptions: {
    
      // swSrc is required in InjectManifest mode.
      swSrc: 'dev/sw.js',
      // ...other Workbox options...
    }
  }

    // 安装
    vue add pwa
    // 使用
    config.plugin('workbox')