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

这篇具有很好参考价值的文章主要介绍了【Vue】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和debugger
 config.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的别名设置为@, 此外,我们可以进行添加文章来源地址https://www.toymoban.com/news/detail-421162.html

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     
                                   }
                }
            });
        }
    }
};

到了这里,关于【Vue】vue.config.js 的完整配置的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • vue.config.js中打包相关配置

    1.原始篇 2.改进篇 通过对chunk生成的css和js文件数量和大小做限制,对代码进行压缩和分割,线上生产环境下使用cdn方式等对webpack打包优化。

    2024年01月22日
    浏览(35)
  • vue.config.js中proxy配置

    这里以axios发请求为例 如果发送的请求都以 /abc 开头,那么我们就可以在proxy中进行服务器代理配置。 3.代理多个接口 方法1:监测多个接口,可以在proxy中写多个配置:(适用于target不同的代理,相同也可以用这个方法,就是会麻烦一点,对于相同的target方法2会比较方便)

    2024年02月22日
    浏览(37)
  • vue.config.js 配置proxy代理

    方案一: 配置文件 文件内容 三个文件分别是三个不同环境使用的,如线上,线上测试,本地测试。我在本地测试时三个文件都配置成了一样。  vue.config.js 配置文件 问题: 控制台显示 400 (Bad Request)或404等问题都是 vue.config.js 配置文件 的 proxy 的配置问题。 主要检查点

    2024年03月15日
    浏览(31)
  • vue2的vue.config.js中简单配置代理跨域

    调用后端接口访问后台数据,但是因为请求url的协议、域名、端口三者之间任意一个与当前页面url不同产生了跨域,我们vue项目运行的地址一般就是localhost 8080端口,而且后端也没有配置允许跨域(后端如果配置跨域通常是cors),所以前端就要配置跨域,Vue跨域在vue.config.j

    2024年02月15日
    浏览(26)
  • vue.config.js使用代理配置真实请求url

    前端请求接口过程中会统一配置代理请求url,配置之后浏览器只能看到local host路径。 为方便查看请求的真实ip,需要在vue.config.js中做如下配置,便能在浏览器实时查看到真实地址 配置完重启,效果如下:

    2024年02月13日
    浏览(42)
  • vue中vite.config.js配置跨域以及环境配置详解

    我们的 .env.development 和 .env.production 文件里面都会有 VITE_APP_ENV 配置: 在我们的 vite.config.js文件中: 以上是 vite.config.js 的配置,上面展示了在不同环境下去请求对应环境的域名并且配置代理进行跨域. 1.在vue.config.js中设置一下代码: 2. 创建axioss实例时,将baseUrl设置为 \\\'/api\\\'

    2024年02月15日
    浏览(36)
  • vue前端开发中,通过vue.config.js配置和nginx配置,实现多个入口文件的实现方法

    由于vue为单页面项目,通过控制组件局部渲染,main.js是整个项目唯一的入口,整个项目都在一个index.html外壳中。 若项目过大,会造成单页面负载过重;同时,多页面利于模块独立部署。 如果项目中不同的页面需要不同的main.js和App.vue这样就需要配置多个入口了。 要单独将页

    2024年01月22日
    浏览(77)
  • vue.config.js配置报错——可能是与webpack混淆

    配置vue.config.js时,报错信息 “Invalid options in vue.config.js: ‘module’ is not allowed” ,表示在 vue.config.js 文件中不允许直接配置 module 选项。 在 Vue CLI 3 及以上版本中, vue.config.js 是用于配置 Vue 项目的文件,但是它只允许配置特定的选项,而不是所有的 Webpack 配置选项。其中,

    2024年02月09日
    浏览(23)
  • Vue+vite创建项目关于vite.config.js文件的配置

    Vue项目创建时,我们见过vue-cli 创建项目和webpack 创建项目等方式。 现在Vue 3版本使用npm/pnpm create vue@latest 创建项目,是搭配使用vite工具构建的。 创建完成的项目,最明显的去别就是,项目配置文件命名不同,当然,配置语法也有不同。 vue-cli 创建的项目,项目配置文件文件

    2024年02月12日
    浏览(39)
  • Vue.config.js 配置报错 ValidationError: Invalid options object.

    接手了别人的项目,在配置 devServer 时直接照搬了之前的配置结果报错 这段报错信息意思是Dev Server已使用与API模式不匹配的选项对象初始化,其中明确指出是属性 ‘disableHostCheck’,于是我屏蔽了这个属性,发现能启动成功 此时我查看了之前和这次的项目的webpack的版本发现

    2024年02月11日
    浏览(90)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包