Webpack 配置文件

本文最后更新于:2024年3月18日 凌晨

Webpack 配置文件

使用不同的配置文件

  • 如果出于某些原因,需要根据特定情况使用不同的配置文件,则可以通过在命令行中使用 --mode 指定配置该参数的配置文件。
1
2
3
4
"scripts": {
"build-dev": "webpack --mode development",
"build-prod": "webpack --mode production",
}

webpack.config.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
const path = require('path');

module.exports = {
mode: "production", // "production" | "development" | "none"
// Chosen mode tells webpack to use its built-in optimizations accordingly.
entry: "./app/entry", // string | object | array
// 默认为 ./src
// 这里应用程序开始执行。
// webpack 开始打包。
output: {
// webpack 如何输出结果的相关选项。
path:path.resolve(__dirname, "dist"), // string (default)
// 所有输出文件的目标路径。
// 必须是绝对路径(使用 Node.js 的 path 模块)
filename: "[name].js", // string (default)
// entry chunk 的文件名模板。
publicPath: "/assets/", // string
// 输出解析文件的目录,url 相对于 HTML 页面。
library: { // 这里有一种旧的语法形式可以使用(点击显示)
type: "umd", // 通用模块定义。
// the type of the exported library
name: "MyLibrary", // string | string[]
// the name of the exported library

/* Advanced output.library configuration*/
},
uniqueName: "my-application", // (defaults to package.json "name")
// unique name for this build to avoid conflicts with other builds in the same HTML
name: "my-config",
// name of the configuration, shown in output
/* 高级输出配置(点击显示)*/
/* Expert output configuration 1 (on own risk) */
/* Expert output configuration 2 (on own risk) */
},
module: {
// 模块配置相关。
rules: [
// 模块规则(配置 loader,解析器等选项)
{
// Conditions:
test: /\.jsx?$/,
include: [
path.resolve(__dirname, "app")
],
exclude: [
path.resolve(__dirname, "app/demo-files")
],
// these are matching conditions, each accepting a regular expression or string
// test and include have the same behavior, both must be matched
// exclude must not be matched (takes preferrence over test and include)
// Best practices:
// - Use RegExp only in test and for filename matching
// - Use arrays of absolute paths in include and exclude to match the full path
// - Try to avoid exclude and prefer include
// Each condition can also receive an object with "and", "or" or "not" properties
// which are an array of conditions.
issuer: /\.css$/,
issuer: path.resolve(__dirname, "app"),
issuer: { and: [ /\.css$/, path.resolve(__dirname, "app") ] },
issuer: { or: [ /\.css$/, path.resolve(__dirname, "app") ] },
issuer: { not: [ /\.css$/ ] },
issuer: [ /\.css$/, path.resolve(__dirname, "app") ], // like "or"
// conditions for the issuer (the origin of the import)
/* Advanced conditions*/

// Actions:
loader: "babel-loader",
// 应该应用的 loader,它相对上下文解析。
options: {
presets: ["es2015"]
},
// options for the loader
use: [
// apply multiple loaders and options instead
"htmllint-loader",
{
loader: "html-loader",
options: {
// ...
}
}
]
type: "javascript/auto",
// specifies the module type
/* Advanced actions*/
},
{
oneOf: [
// ... (rules)
]
// only use one of these nested rules
},
{
// ... (conditions)
rules: [
// ... (rules)
]
// use all of these nested rules (combine with conditions to be useful)
},
],
/* 高级模块配置 */
},
resolve: {
// options for resolving module requests
// (does not apply to resolving of loaders)
modules: ["node_modules",path.resolve(__dirname, "app")],
// directories where to look for modules (in order)
extensions: [".js", ".json", ".jsx", ".css"],
// 使用的扩展名。
alias: {
// a list of module name aliases
// aliases are imported relative to the current context
"module": "new-module",
// 别名:"module" -> "new-module" 和 "module/path/file" -> "new-module/path/file"
"only-module$": "new-module",
// 别名 "only-module" -> "new-module",但不匹配 "only-module/path/file" -> "new-module/path/file"
"module": path.resolve(__dirname, "app/third/module.js"),
// alias "module" -> "./app/third/module.js" and "module/file" results in error
"module": path.resolve(__dirname, "app/third"),
// alias "module" -> "./app/third" and "module/file" -> "./app/third/file"
[path.resolve(__dirname, "app/module.js")]: path.resolve(__dirname, "app/alternative-module.js"),
// alias "./app/module.js" -> "./app/alternative-module.js"
},
/* 可供选择的别名语法 */
/* 高级解析选项 */
/* Expert resolve configuration*/
},
performance: {
hints: "warning", // 枚举。
maxAssetSize: 200000, // 整数类型(以字节为单位)
maxEntrypointSize: 400000, // 整数类型(以字节为单位)
assetFilter: function(assetFilename) {
// 提供资源文件名的断言函数。
return assetFilename.endsWith('.css') || assetFilename.endsWith('.js');
}
},
devtool: "source-map", // enum
// 通过为浏览器调试工具提供极其详细的源映射的元信息来增强调试能力。
// 但会牺牲构建速度。
context: __dirname, // string(绝对路径!)
// webpack 的主目录。
// entry 和 module.rules.loader 选项。
// 都相对于此目录解析。
target: "web", // 枚举。
// the environment in which the bundle should run
// changes chunk loading behavior, available external modules
// and generated code style
externals: ["react", /^@angular/],
// Don't follow/bundle these modules, but request them at runtime from the environment
externalsType: "var", // (defaults to output.library.type)
// Type of externals, when not specified inline in externals
externalsPresets: { /* ... */ },
// presets of externals
ignoreWarnings: [/warning/],
stats: "errors-only",
stats: {
// lets you precisely control what bundle information gets displayed
preset: "errors-only",
// A stats preset

/* Advanced global settings*/

env: true,
// include value of --env in the output
outputPath: true,
// include absolute output path in the output
publicPath: true,
// include public path in the output

assets: true,
// show list of assets in output
/* Advanced assets settings*/

entrypoints: true,
// show entrypoints list
chunkGroups: true,
// show named chunk group list
/* Advanced chunk group settings*/

chunks: true,
// show list of chunks in output
/* Advanced chunk group settings*/

modules: true,
// show list of modules in output
/* Advanced module settings*/
/* Expert module settings*/

/* Advanced optimization settings*/

children: true
// show stats for child compilations

logging: true,
// show logging in output
loggingDebug: /webpack/,
// show debug type logging for some loggers
loggingTrace: true,
// show stack traces for warnings and errors in logging output

warnings: true
// show warnings

errors: true,
// show errors
errorDetails: true,
// show details for errors
errorStack: true,
// show internal stack trace for errors
moduleTrace: true,
// show module trace for errors
// (why was causing module referenced)

builtAt: true,
// show timestamp in summary
errorsCount: true,
// show errors count in summary
warningsCount: true,
// show warnings count in summary
timings: true,
// show build timing in summary
version: true,
// show webpack version in summary
hash: true,
// show build hash in summary
},
devServer: {
proxy: { // proxy URLs to backend development server
'/api': 'http://localhost:3000'
},
contentBase: path.join(__dirname, 'public'), // boolean | string | array, static file location
compress: true, // enable gzip compression
historyApiFallback: true, // true for index.html upon 404, object for multiple paths
hot: true, // hot module replacement. Depends on HotModuleReplacementPlugin
https: false, // true for self-signed, object for cert authority
noInfo: true, // only errors & warns on hot reload
// ...
},
experiments: {
asyncWebAssembly: true,
// WebAssembly as async module (Proposal)
syncWebAssembly: true,
// WebAssembly as sync module (deprecated)
outputModule: true,
// Allow to output ESM
topLevelAwait: true,
// Allow to use await on module evaluation (Proposal)
}
plugins: [
// ...
],
// list of additional plugins
optimization: {
chunkIds: "size",
// method of generating ids for chunks
moduleIds: "size",
// method of generating ids for modules
mangleExports: "size",
// rename export names to shorter names
minimize: true,
// minimize the output files
minimizer: [new CssMinimizer(), "..."],
// minimizers to use for the output files

/* Advanced optimizations*/

splitChunks: {
cacheGroups: {
"my-name": {
// define groups of modules with specific
// caching behavior
test: /\.sass$/,
type: "css/mini-extract",

/* Advanced selectors*/

/* Advanced effects*/
}
},

fallbackCacheGroup: { /* Advanced*/ }

/* Advanced selectors*/

/* Advanced effects*/

/* Expert settings*/
}
},
/* 高级配置 */
/* Advanced caching configuration*/
/* Advanced build configuration*/

分离配置文件

安装

1
$ yarn add -D webpack-merge

配置

  • webpack.base.config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
const path = require('path');
const { VueLoaderPlugin } = require('vue-loader');
const HtmlWebpackPlugin = require('html-webpack-plugin');

const config = {
entry: './src/main.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'bundle.js'
},
module: {
rules: [
{
test: /\.js$/,
exclude: /(node_modules|bower_components)/,
use: [
{
loader: 'babel-loader',
options: {
presets: ['es2015']
}
}
]
},
{
test: /\.css$/,
use: [
{
loader: "vue-style-loader"
}, {
loader: "css-loader",
options: {
modules: true
}
},
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
"postcss-preset-env",
require('autoprefixer')
],
},
},
}
]
},
{
test: /\.s[ac]ss$/i,
use: [
// 将 JS 字符串生成为 style 节点。
"style-loader",
// 将 CSS 转化成 CommonJS 模块。
"css-loader",
// 将 Sass 编译成 CSS
"sass-loader",
],
},
{
test: /\.(png|jpg|gif|jpeg)$/i,
use: [
{
loader: 'url-loader',
options: {
limit: 8192,
name: '[name].[ext]?[hash:8]',
outputPath: 'static/img/'
}
}
],
},
{
test: /\.vue$/,
loader: 'vue-loader'
}
]
},
resolve: {
extensions: [".js", ".json", ".jsx", ".css", ".vue"]
},
plugins: [
// 请确保引入这个插件!
new VueLoaderPlugin(),
new HtmlWebpackPlugin({
template: __dirname + "/public/index.tmpl.html"
})
]
};

module.exports = config;
  • webpack.development.config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
const webpackMerge = require('webpack-merge')
const webpackConfig = require('./webpack.config.js')

const config = {
mode: 'development',
devtool: 'eval-source-map',
devServer: {
contentBase: "./dist", // 本地服务器所加载的页面所在的目录。
stats: { colors: true },//colors: true终端中输‰出结果为彩色。
historyApiFallback: true, // 不跳转。
inline: true, // 实时刷新。
hot: true,
port: 8000
},
};
module.exports = webpackMerge.merge(webpackConfig, config)
  • webpack.production.config.js
1
2
3
4
5
6
7
8
9
10
11
12
const webpackMerge = require('webpack-merge')
const webpackConfig = require('./webpack.config')
const webpack = require('webpack');

const config = {
mode: 'production',
plugins: [
new webpack.BannerPlugin('Copyright')
]
};

module.exports = webpackMerge.merge(webpackConfig,config)

缓存

  • 缓存无处不在,使用缓存的最好方法是保证你的文件名和文件内容是匹配的(内容改变,名称相应改变)
  • webpack可以把一个Hash值添加到打包的文件名中,使用方法如下,添加特殊的字符串混合体([name], [id] and [hash])到输出文件名前。
1
2
3
4
5
6
7
const webpack = require('webpack');
module.exports = {
output: {
path: path.resolve(__dirname, 'dist'),
filename: "bundle-[hash].js"
}
};

本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!