> 文章列表 > 【Vue】vue.config.js 的完整配置

【Vue】vue.config.js 的完整配置

【Vue】vue.config.js 的完整配置

文章目录

  • 一、介绍
  • 二、基本配置
  • 三、插件及规则的配置
  • 四、规则rules的配置
    • 4.1 rules的新增
    • 4.2 rules的修改
  • 五、插件plugins 的配置
    • 5.1 plugins的新增
    • 5.2 plugins的修改
    • 5.3 plugins的删除
  • 六、一些常见的配置
    • 6.1 修改enter文件
    • 6.2 DefinePlugin
    • 6.3 自定义filename 及 chunkFilename
    • 6.4 修改html-webpack-plugin参数
    • 6.5 设置别名alias
  • 七、附上一份vue.config.js的配置

一、介绍

之前,我有提到过,当然大家肯定也都知道,Vue3.0不在有webpack.config.js的配置;但是不可避免,在项目开发中我们肯定会存在一些特殊的需求需要调整webpack, 这个时候,在Vue3.0的项目当中,我们就需要在根目录创建vue.config.js去完成webpack的一些特殊配置,默认它会被 @vue/cli-service 自动加载。
此刻,你需要创建vue.config.js文件。

查看默认的webpack配置
Vue CLI 官方文档:vue-cli-service 暴露了 inspect 命令用于审查解析好的 webpack 配置。那个全局的 vue 可执行程序同样提供了 inspect 命令,这个命令只是简单的把 vue-cli-service``inspect 代理到了你的项目中。

被抽象化的webpack,我们要想去理解它默认的一些配置的话是比较困难的,所以我们可以通过指令去查看。
该指令会将webpack的配置输出到output.js文件,这样方便去查看。
vue inspect > output.js
vue.config.js文件
这个文件导出了一个包含了选项的对象:
module.exports = { // 选项...}
接下来,详细介绍一些选项及配置:

二、基本配置

module.exports = {  productionSourceMap: false,publicPath: './',    
outputDir: 'dist', assetsDir: 'assets',    
devServer: {       port: 8090, host: '0.0.0.0', https: false,  open: true    },    // 其他配置
  • productionSourceMap:生产环境是否要生成 sourceMap
  • publicPath:部署应用包时的基本 URL,用法和 webpack 本身的 output.publicPath 一致
    • 可以通过三元运算去配置dev和prod环境, publicPath:
    • process.env.NODE_ENV === ‘production’ ? ‘/prod/’ : ‘./’
  • outputDir: build 时输出的文件目录
  • assetsDir: 放置静态文件夹目录
  • devServer: dev环境下,webpack-dev-server 相关配置
    • port: 开发运行时的端口
    • host: 开发运行时域名,设置成’0.0.0.0’,在同一个局域网下,如果你的项目在运行,同时可以通过你的http://ip:port/…访问你的项目
    • https: 是否启用 https
    • open: npm run serve 时是否直接打开浏览器

三、插件及规则的配置

在vue.config.js如果要新增/修改 webpack 的 plugins 或者 rules , 有2种方式

configureWebpack 方式
configureWebpack 是相对比较简单的一种方式

  • 它可以是一个对象:和 webpack 本身配置方式是一致,该对象将会被 webpack-merge 合并入最终的 webpack 配置
  • 它也可以是一个函数:直接在函数内部进行修改配置
configureWebpack: {rules:[],plugins: []}
configureWebpack: (config) => {// 例如,通过判断运行环境,设置mode  config.mode = 'production'} 

chainWebpack 方式
chainWebpack 链式操作 (高级),接下来所有的配置我都会在该选项中进行配置

四、规则rules的配置

关于rules 的配置,我会分别从新增/修改进行介绍。

4.1 rules的新增

在webpack中 rules 是 module 的配置项,而所有的配置的都是挂载到 config 下的,所以新增一个rule方式:

config.module.rule(name) .use(name)      .loader(loader)    .options(options)

案例:
style-resources-loader 来添加less全局变量;
svg-sprite-loader 将svg图片以雪碧图的方式在项目中加载;

module.exports = {    chainWebpack: (config) => {// 通过 style-resources-loader 来添加less全局变量const types = ['vue-modules', 'vue', 'normal-modules', 'normal'];types.forEach(type => {            
let rule = config.module.rule('less').oneOf(type)    rule.use('style-resource').loader('style-resources-loader').options({                   patterns: [path.resolve(__dirname, './lessVariates.less')]  });
});

// svg-sprite-loader: 将svg图片以雪碧图的方式在项目中加载

   	config.module.rule('svg').test(/.svg$/) // 匹配svg文件.include.add(resolve('src/svg')) // 主要匹配src/svg.end() .use('svg-sprite-loader').loader('svg-sprite-loader') // 使用的loader,主要要npm该插件.options({symbolId: 'svg-[name]'}) // 参数配置}
}

4.2 rules的修改

针对已经存在的 rule , 如果需要修改它的参数, 可以使用 tap 方法:

config.module.rule(name)   .use(name)      .tap(options => newOptions)

案例:
修改url-loader的参数;

module.exports = {chainWebpack: (config) => {    // `url-loader`是webpack默认已经配置的,现在我们来修改它的参数   config.module.rule('images').use('url-loader').tap(options => ({              name: './assets/images/[name].[ext]',quality: 85, limit: 0, esModule: false,        }))}
}

五、插件plugins 的配置

关于 plugins 的配置,我会分别从新增/修改/删除进行介绍。

5.1 plugins的新增

注意:这里WebpackPlugin不需要通过new WebpackPlugin()使用。

config  .plugin(name)  .use(WebpackPlugin, args)

案例:
新增hot-hash-webpack-plugin;

const HotHashWebpackPlugin = require('hot-hash-webpack-plugin');
module.exports = {    
chainWebpack: (config) => { // 新增一个`hot-hash-webpack-plugin`// 注意:这里use的时候不需要使用`new HotHashWebpackPlugin()`config.plugin('hotHash').use(HotHashWebpackPlugin, [{ version: '1.0.0' }]);}
}

5.2 plugins的修改

同理, plugin 参数的修改也是通过 tap 去修改。

config.plugin(name).tap(args => newArgs)

案例:
修改打包后css抽离后的filename及抽离所属目录;
删除console和debugger;

const HotHashWebpackPlugin = require('hot-hash-webpack-plugin');
module.exports = {chainWebpack: (config) => {// 修改打包时css抽离后的filename及抽离所属目录config.plugin('extract-css').tap(args => [{filename: 'css/[name].[contenthash:8].css',chunkFilename: 'css/[name].[contenthash:8].css'}]) // 正式环境下,删除console和debuggerconfig.optimization.minimize(true).minimizer('terser').tap(args => {let { terserOptions } = args[0];terserOptions.compress.drop_console = true;terserOptions.compress.drop_debugger = true;return args});}
}

5.3 plugins的删除

对于一些webpack默认的 plugin ,如果不需要可以进行删除

config.plugins.delete(name)

案例:
删除 vue-cli3.X 模块的自动分割抽离

module.exports = {chainWebpack: (config) => {  // vue-cli3.X 会自动进行模块分割抽离,如果不需要进行分割,可以手动删除 config.optimization.delete('splitChunks');     }
}

六、一些常见的配置

6.1 修改enter文件

webpack 默认的 entry 入口是 scr/main.ts

config.entryPoints.clear(); 

//清空默认入口

config.entry('test').add(getPath('./test/main.ts'));

// 重新设置

6.2 DefinePlugin

定义全局全局变量,DefinePlugin 是 webpack 已经默认配置的,我们可以对参数进行修改

config.plugin('define').tap(args => [{ ...args, "window.isDefine": JSON.stringify(true),}]);

6.3 自定义filename 及 chunkFilename

自定义打包后js文件的路径及文件名字

config.output.filename('./js/[name].[chunkhash:8].js');
config.output.chunkFilename('./js/[name].[chunkhash:8].js');

6.4 修改html-webpack-plugin参数

html-webpack-plugin 是 webpack 已经默认配置的,默认的源模版文件是 public/index.html ;我们可以对其参数进行修改

 config.plugin('html').tap(options => [{template: '../../index.html' // 修改源模版文件title: 'test',}]);

6.5 设置别名alias

webpack默认是将src的别名设置为@, 此外,我们可以进行添加

config.resolve.alias.set('@', resolve('src')) .set('api', resolve('src/apis')).set('common', resolve('src/common'))

七、附上一份vue.config.js的配置

const path = require('path');
const HotHashWebpackPlugin = require('hot-hash-webpack-plugin');
const WebpackBar = require('webpackbar');
const resolve = (dir) => path.join(__dirname, '.', dir);
module.exports = {productionSourceMap: false,publicPath: './',outputDir: 'dist',assetsDir: 'assets',devServer: {port: 9999,host: '0.0.0.0',https: false,open: true},chainWebpack: (config) => {       const types = ['vue-modules', 'vue', 'normal-modules', 'normal'];  types.forEach(type => {let rule = config.module.rule('less').oneOf(type)rule.use('style-resource').loader('style-resources-loader').options({  patterns: [path.resolve(__dirname, './lessVariates.less')] });});config.resolve.alias.set('@', resolve('src')) .set('api', resolve('src/apis')).set('common', resolve('src/common'))config.module.rule('images').use('url-loader').tap(options => ({ name: './assets/images/[name].[ext]', quality: 85,      limit: 0,  esModule: false,  }));config.module.rule('svg').test(/.svg$/).include.add(resolve('src/svg')).end().use('svg-sprite-loader').loader('svg-sprite-loader');config.plugin('define').tap(args => [{...args, "window.isDefine": JSON.stringify(true)}]);        // 生产环境配置if (process.env.NODE_ENV === 'production') {config.output.filename('./js/[name].[chunkhash:8].js');config.output.chunkFilename('./js/[name].[chunkhash:8].js');config.plugin('extract-css').tap(args => [{         filename: 'css/[name].[contenthash:8].css',     chunkFilename: 'css/[name].[contenthash:8].css'}]);config.plugin('hotHash').use(HotHashWebpackPlugin, [{version : '1.0.0'}]);config.plugin('webpackBar').use(WebpackBar);config.optimization.minimize(true).minimizer('terser').tap(args => {let { terserOptions } = args[0];terserOptions.compress.drop_console = true;terserOptions.compress.drop_debugger = true;  return args});config.optimization.splitChunks({      cacheGroups: {  common: {        name: 'common',   chunks: 'all',  minSize: 1,     minChunks: 2,      priority: 1},                 vendor:    name: 'chunk-libs',        chunks: 'all',   test: /[\\/]node_modules[\\/]/,   priority: 10     }}});}}
};