vue.config.js完整配置教程
引言
前段時(shí)間,對(duì)部門(mén)的個(gè)別項(xiàng)目進(jìn)行Vue3.0+ts框架的遷移,剛開(kāi)始研究的時(shí)候也是踩坑特別多,尤其我們的項(xiàng)目還有些特殊的webpack配置,所以,研究vue.config.js的配置的時(shí)候也是查閱了各種資料文檔,最終,完成了項(xiàng)目webpack的特殊配置。
今天分享一下,我們項(xiàng)目當(dāng)中的一些webpack配置,希望能給大家有所啟發(fā);只要配置多了,你就會(huì)發(fā)現(xiàn)其實(shí)所有的配置的都是相似的,尤其像插件的配置,都是十分相似的。
我們現(xiàn)在開(kāi)始進(jìn)入今天的主題啦~~
1 介紹
之前,我有提到過(guò),當(dāng)然大家肯定也都知道,Vue3.0不在有webpack.config.js的配置;但是不可避免,在項(xiàng)目開(kāi)發(fā)中我們肯定會(huì)存在一些特殊的需求需要調(diào)整webpack, 這個(gè)時(shí)候,在Vue3.0的項(xiàng)目當(dāng)中,我們就需要在根目錄創(chuàng)建vue.config.js去完成webpack的一些特殊配置,默認(rèn)它會(huì)被 @vue/cli-service 自動(dòng)加載。
此刻,你需要?jiǎng)?chuàng)建vue.config.js文件。
查看默認(rèn)的webpack配置
Vue CLI 官方文檔:vue-cli-service 暴露了 inspect 命令用于審查解析好的 webpack 配置。
那個(gè)全局的 vue 可執(zhí)行程序同樣提供了 inspect 命令,這個(gè)命令只是簡(jiǎn)單的把 vue-cli-service``inspect 代理到了你的項(xiàng)目中。
被抽象化的webpack,我們要想去理解它默認(rèn)的一些配置的話是比較困難的,所以我們可以通過(guò)指令去查看。
該指令會(huì)將webpack的配置輸出到output.js文件,這樣方便去查看。
vue inspect > output.js
vue.config.js文件
這個(gè)文件導(dǎo)出了一個(gè)包含了選項(xiàng)的對(duì)象:
module.exports = {
// 選項(xiàng)...
}
接下來(lái),詳細(xì)介紹一些選項(xiàng)及配置:
2 基本配置
module.exports = {
productionSourceMap: false,
publicPath: './',
outputDir: 'dist',
assetsDir: 'assets',
devServer: {
port: 8090,
host: '0.0.0.0',
https: false,
open: true
},
// 其他配置
...
productionSourceMap:生產(chǎn)環(huán)境是否要生成 sourceMap
publicPath:部署應(yīng)用包時(shí)的基本 URL,用法和 webpack 本身的 output.publicPath 一致
可以通過(guò)三元運(yùn)算去配置dev和prod環(huán)境,
publicPath: process.env.NODE_ENV === 'production' ? '/prod/' : './'
outputDir: build 時(shí)輸出的文件目錄
assetsDir: 放置靜態(tài)文件夾目錄
devServer: dev環(huán)境下,webpack-dev-server 相關(guān)配置
- port: 開(kāi)發(fā)運(yùn)行時(shí)的端口
- host: 開(kāi)發(fā)運(yùn)行時(shí)域名,設(shè)置成
'0.0.0.0',在同一個(gè)局域網(wǎng)下,如果你的項(xiàng)目在運(yùn)行,同時(shí)可以通過(guò)你的http://ip:port/...訪問(wèn)你的項(xiàng)目 - https: 是否啟用
https - open:
npm run serve時(shí)是否直接打開(kāi)瀏覽器
3 插件及規(guī)則的配置
在vue.config.js如果要新增/修改 webpack 的 plugins 或者 rules , 有2種方式。
configureWebpack 方式
configureWebpack 是相對(duì)比較簡(jiǎn)單的一種方式
- 它可以是一個(gè)對(duì)象:和
webpack本身配置方式是一致,該對(duì)象將會(huì)被webpack-merge合并入最終的webpack配置 - 它也可以是一個(gè)函數(shù):直接在函數(shù)內(nèi)部進(jìn)行修改配置
configureWebpack: {
rules:[],
plugins: []
}
configureWebpack: (config) => {
// 例如,通過(guò)判斷運(yùn)行環(huán)境,設(shè)置mode
config.mode = 'production'
}
chainWebpack 方式
chainWebpack 鏈?zhǔn)讲僮?(高級(jí)),接下來(lái)所有的配置我都會(huì)在該選項(xiàng)中進(jìn)行配置
4 規(guī)則rules的配置
關(guān)于rules 的配置,我會(huì)分別從新增/修改進(jìn)行介紹。
4.1 rules的新增
在webpack中 rules 是 module 的配置項(xiàng),而所有的配置的都是掛載到 config 下的,所以新增一個(gè)rule方式:
config.module
.rule(name)
.use(name)
.loader(loader)
.options(options)
案例:style-resources-loader 來(lái)添加less全局變量
案例:svg-sprite-loader 將svg圖片以雪碧圖的方式在項(xiàng)目中加載
module.exports = {
chainWebpack: (config) => {
// 通過(guò) style-resources-loader 來(lái)添加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圖片以雪碧圖的方式在項(xiàng)目中加載
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]'}) // 參數(shù)配置
}
}
4.2 rules的修改
針對(duì)已經(jīng)存在的 rule , 如果需要修改它的參數(shù), 可以使用 tap 方法:
config.module
.rule(name)
.use(name)
.tap(options => newOptions)
案例:修改url-loader的參數(shù)
module.exports = {
chainWebpack: (config) => {
// `url-loader`是webpack默認(rèn)已經(jīng)配置的,現(xiàn)在我們來(lái)修改它的參數(shù)
config.module.rule('images')
.use('url-loader')
.tap(options => ({
name: './assets/images/[name].[ext]',
quality: 85,
limit: 0,
esModule: false,
}))
}
}
5 插件plugins 的配置
關(guān)于 plugins 的配置,我會(huì)分別從新增/修改/刪除進(jìn)行介紹。
5.1 plugins的新增
- 注意:這里WebpackPlugin不需要通過(guò)
new WebpackPlugin()使用。
config .plugin(name) .use(WebpackPlugin, args)
案例:新增hot-hash-webpack-plugin
const HotHashWebpackPlugin = require('hot-hash-webpack-plugin');
module.exports = {
chainWebpack: (config) => {
// 新增一個(gè)`hot-hash-webpack-plugin`
// 注意:這里use的時(shí)候不需要使用`new HotHashWebpackPlugin()`
config.plugin('hotHash')
.use(HotHashWebpackPlugin, [{ version: '1.0.0' }]);
}
}
5.2 plugins的修改
同理, plugin 參數(shù)的修改也是通過(guò) tap 去修改。
config
.plugin(name)
.tap(args => newArgs)
案例:修改打包后css抽離后的filename及抽離所屬目錄
案例:刪除console和debugger
const HotHashWebpackPlugin = require('hot-hash-webpack-plugin');
module.exports = {
chainWebpack: (config) => {
// 修改打包時(shí)css抽離后的filename及抽離所屬目錄
config.plugin('extract-css')
.tap(args => [{
filename: 'css/[name].[contenthash:8].css',
chunkFilename: 'css/[name].[contenthash:8].css'
}]);
// 正式環(huán)境下,刪除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的刪除
對(duì)于一些webpack默認(rèn)的 plugin ,如果不需要可以進(jìn)行刪除
config.plugins.delete(name)
案例:刪除 vue-cli3.X 模塊的自動(dòng)分割抽離
module.exports = {
chainWebpack: (config) => {
// vue-cli3.X 會(huì)自動(dòng)進(jìn)行模塊分割抽離,如果不需要進(jìn)行分割,可以手動(dòng)刪除
config.optimization.delete('splitChunks');
}
}
6 一些常見(jiàn)的配置
6.1 修改enter文件
webpack 默認(rèn)的 entry 入口是 scr/main.ts
config.entryPoints.clear(); // 清空默認(rèn)入口
config.entry('test').add(getPath('./test/main.ts')); // 重新設(shè)置
6.2 DefinePlugin
定義全局全局變量,DefinePlugin 是 webpack 已經(jīng)默認(rèn)配置的,我們可以對(duì)參數(shù)進(jìn)行修改
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參數(shù)
html-webpack-plugin 是 webpack 已經(jīng)默認(rèn)配置的,默認(rèn)的源模版文件是 public/index.html ;我們可以對(duì)其參數(shù)進(jìn)行修改
config.plugin('html')
.tap(options => [{
template: '../../index.html' // 修改源模版文件
title: 'test',
}]);
6.5 設(shè)置別名alias
webpack默認(rèn)是將src的別名設(shè)置為@, 此外,我們可以進(jìn)行添加
config.resolve.alias
.set('@', resolve('src'))
.set('api', resolve('src/apis'))
.set('common', resolve('src/common'))
7 附上一份我的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)
}]);
// 生產(chǎn)環(huán)境配置
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.config.js 的完整配置的詳細(xì)內(nèi)容,更多關(guān)于vue.config.js配置的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- vue.config.js常用配置詳解
- Vue-cli3項(xiàng)目配置Vue.config.js實(shí)戰(zhàn)記錄
- 如何配置vue.config.js 處理static文件夾下的靜態(tài)文件
- vue-cli3中vue.config.js配置教程詳解
- vue3中vue.config.js配置及注釋詳解
- vue2之vue.config.js最全配置教程
- vue配置vue.config.js超詳細(xì)教程
- vue3中配置文件vue.config.js不生效的解決辦法
- Vue.config.js配置報(bào)錯(cuò)ValidationError:?Invalid?options?object解決辦法
- vue.config.js配置報(bào)錯(cuò)解決辦法(可能是與webpack混淆)
相關(guān)文章
Vue3?計(jì)算屬性computed的實(shí)現(xiàn)原理
這篇文章主要介紹了Vue3?計(jì)算屬性computed的實(shí)現(xiàn)原理,文章圍繞主題展開(kāi)詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的朋友可以參考一下2022-08-08
vue金額格式化保留兩位小數(shù)的實(shí)現(xiàn)
這篇文章主要介紹了vue金額格式化保留兩位小數(shù)的實(shí)現(xiàn)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-04-04
Vue3使用video-player實(shí)現(xiàn)視頻播放
video-player是一個(gè)基于video.js的視頻播放器組件,本文主要介紹了Vue3使用video-player實(shí)現(xiàn)視頻播放,具有一定的參考價(jià)值,感興趣的可以了解一下2024-01-01
Element控件Tree實(shí)現(xiàn)數(shù)據(jù)樹(shù)形結(jié)構(gòu)的示例代碼
我們?cè)陂_(kāi)發(fā)中肯定會(huì)遇到用樹(shù)形展示數(shù)據(jù)的需求,本文主要介紹了Element控件Tree實(shí)現(xiàn)數(shù)據(jù)樹(shù)形結(jié)構(gòu)的示例代碼,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-08-08
詳解Vue如何進(jìn)行分布式事務(wù)管理以及解決方案
在分布式系統(tǒng)中,事務(wù)管理是一個(gè)非常重要的問(wèn)題,所以本文將介紹一下Vue中如何進(jìn)行分布式事務(wù)管理以及分布式事務(wù)解決方案,希望對(duì)大家有所幫助2023-06-06
vue如何判斷數(shù)組中的對(duì)象是否包含某個(gè)值
這篇文章主要介紹了vue如何判斷數(shù)組中的對(duì)象是否包含某個(gè)值,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-08-08
vue菜單欄聯(lián)動(dòng)內(nèi)容頁(yè)面tab的實(shí)現(xiàn)示例
本文主要介紹了vue菜單欄聯(lián)動(dòng)內(nèi)容頁(yè)面tab的實(shí)現(xiàn)示例,左側(cè)菜單欄與右側(cè)內(nèi)容部分聯(lián)動(dòng),當(dāng)點(diǎn)擊左側(cè)的菜單,右側(cè)會(huì)展示對(duì)應(yīng)的tab,具有一定的參考價(jià)值,感興趣的可以了解一下2024-01-01
Vue-cli創(chuàng)建項(xiàng)目從單頁(yè)面到多頁(yè)面的方法
本篇文章主要介紹了Vue-cli創(chuàng)建項(xiàng)目從單頁(yè)面到多頁(yè)面的方法,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-09-09
Vue使用ajax(axios)請(qǐng)求后臺(tái)數(shù)據(jù)的方法教程
在vue中經(jīng)常會(huì)用到數(shù)據(jù)請(qǐng)求,下面這篇文章主要給大家介紹了關(guān)于Vue使用ajax(axios)請(qǐng)求后臺(tái)數(shù)據(jù)的方法教程,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-11-11
vue 動(dòng)態(tài)改變靜態(tài)圖片以及請(qǐng)求網(wǎng)絡(luò)圖片的實(shí)現(xiàn)方法
下面小編就為大家分享一篇vue 動(dòng)態(tài)改變靜態(tài)圖片以及請(qǐng)求網(wǎng)絡(luò)圖片的實(shí)現(xiàn)方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-02-02

