Skip to content

Commit a720488

Browse files
fix(config): accept optimization.minimizeOptions as a configured option
A resolved config is a valid input to `webpack()`, so a normalized-only key made it fail validation — `Compiler-caching` feeds one straight back. Add `minimizeOptions` to the option schema, where it overrides what the `minimize` shorthand names, and shorten the comments around it.
1 parent 3bacdce commit a720488

10 files changed

Lines changed: 607 additions & 27 deletions

File tree

‎declarations/WebpackOptions.d.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2319,9 +2319,13 @@ export interface Optimization {
23192319
*/
23202320
mergeDuplicateChunks?: boolean;
23212321
/**
2322-
* Enable minimizing the output. Uses optimization.minimizer. An options object implies 'true' and configures the built-in minimizer per asset type.
2322+
* Enable minimizing the output. Uses optimization.minimizer. An options object implies 'true' and sets optimization.minimizeOptions.
23232323
*/
23242324
minimize?: boolean | OptimizationMinimizeOptions;
2325+
/**
2326+
* Enable minimizing the output, configured per asset type. An absent type is minimized with the defaults; `false` disables minimizing it.
2327+
*/
2328+
minimizeOptions?: OptimizationMinimizeOptions;
23252329
/**
23262330
* Minimizer(s) to use for minimizing the output.
23272331
*/

‎lib/config/defaults.js‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2466,11 +2466,8 @@ const applyOptimizationDefaults = (
24662466
D(optimization, "mangleWasmImports", false);
24672467
D(optimization, "portableRecords", records);
24682468
D(optimization, "realContentHash", production);
2469-
// A plugin can assign the object shorthand in `apply()`, which runs after
2470-
// normalization: fold it in here too, so `minimize` stays a boolean. It
2471-
// replaces the configured options rather than defaulting them, as
2472-
// overwriting the resolved option always has. The normalized type is
2473-
// already a boolean, hence the cast.
2469+
// A plugin assigning the object shorthand in `apply()` runs after
2470+
// normalization: it replaces `minimizeOptions`, keeping `minimize` boolean.
24742471
const minimizeAssignedInApply = /** @type {unknown} */ (
24752472
optimization.minimize
24762473
);
@@ -2515,9 +2512,7 @@ const applyOptimizationDefaults = (
25152512
compiler
25162513
);
25172514

2518-
// Normalized + defaulted `optimization.minimizeOptions` is the
2519-
// per-asset-type object: `false` disables a type, an object is its
2520-
// options.
2515+
// Per asset type: `false` disables that type, an object is its options.
25212516
const minimizeByType = /** @type {OptimizationMinimizeOptions} */ (
25222517
compiler.options.optimization.minimizeOptions
25232518
);

‎lib/config/normalization.js‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,8 @@ const getNormalizedWebpackOptions = (config) => ({
336336
minimize:
337337
typeof optimization.minimize === "object" ? true : optimization.minimize,
338338
minimizeOptions: getNormalizedOptimizationMinimizeOptions(
339-
optimization.minimize
339+
optimization.minimize,
340+
optimization.minimizeOptions
340341
),
341342
minimizer:
342343
optimization.minimizer !== undefined
@@ -618,12 +619,18 @@ const getNormalizedEntryStatic = (entry) => {
618619
};
619620

620621
/**
621-
* Gets the per-asset-type options out of the `minimize` shorthand: `minimize`
622-
* itself stays the boolean plugins have always read off the resolved config.
622+
* Gets the per-asset-type minimize options: `minimize` itself stays the boolean
623+
* plugins have always read off the resolved config, and its object form is a
624+
* shorthand `minimizeOptions` overrides.
623625
* @param {Optimization["minimize"]} minimize minimize option
626+
* @param {Optimization["minimizeOptions"]} minimizeOptions minimizeOptions option
624627
* @returns {OptimizationNormalized["minimizeOptions"]} normalized minimize options
625628
*/
626-
const getNormalizedOptimizationMinimizeOptions = (minimize) => {
629+
const getNormalizedOptimizationMinimizeOptions = (
630+
minimize,
631+
minimizeOptions
632+
) => {
633+
if (minimizeOptions !== undefined) return cloneObject(minimizeOptions);
627634
if (typeof minimize !== "object") return;
628635
return cloneObject(minimize);
629636
};

‎schemas/WebpackOptions.check.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎schemas/WebpackOptions.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3603,7 +3603,7 @@
36033603
"type": "boolean"
36043604
},
36053605
"minimize": {
3606-
"description": "Enable minimizing the output. Uses optimization.minimizer. An options object implies 'true' and configures the built-in minimizer per asset type.",
3606+
"description": "Enable minimizing the output. Uses optimization.minimizer. An options object implies 'true' and sets optimization.minimizeOptions.",
36073607
"anyOf": [
36083608
{
36093609
"type": "boolean"
@@ -3613,6 +3613,9 @@
36133613
}
36143614
]
36153615
},
3616+
"minimizeOptions": {
3617+
"$ref": "#/definitions/OptimizationMinimizeOptions"
3618+
},
36163619
"minimizer": {
36173620
"description": "Minimizer(s) to use for minimizing the output.",
36183621
"type": "array",

‎test/Defaults.unittest.js‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6063,13 +6063,28 @@ describe("optimization.minimize", () => {
60636063
);
60646064
});
60656065

6066+
it("should let `minimizeOptions` override the `minimize` shorthand", () => {
6067+
expect(
6068+
resolve({ minimize: true, minimizeOptions: { css: false } }).optimization
6069+
.minimizeOptions
6070+
).toEqual({ ...DEFAULT_MINIMIZE_OPTIONS, css: false });
6071+
expect(
6072+
resolve({ minimize: { css: false }, minimizeOptions: { html: false } })
6073+
.optimization.minimizeOptions
6074+
).toEqual({ ...DEFAULT_MINIMIZE_OPTIONS, html: false });
6075+
// A resolved config is a valid input, so it normalizes back to itself.
6076+
expect(
6077+
resolve({ minimize: true, minimizeOptions: DEFAULT_MINIMIZE_OPTIONS })
6078+
.optimization.minimizeOptions
6079+
).toEqual(DEFAULT_MINIMIZE_OPTIONS);
6080+
});
6081+
60666082
it("should accept a shorthand assigned after normalization", () => {
60676083
const { applyWebpackOptionsDefaults, getNormalizedWebpackOptions } =
60686084
require("..").config;
60696085

6070-
// What a plugin does in `apply()`, which runs between normalization and
6071-
// defaults, so neither form is normalized. The normalized type is a
6072-
// boolean, hence the casts.
6086+
// What a plugin does in `apply()`, between normalization and defaults.
6087+
// The normalized type is a boolean, hence the casts.
60736088
const withTrue = getNormalizedWebpackOptions({ mode: "development" });
60746089
withTrue.optimization.minimize = /** @type {EXPECTED_ANY} */ (true);
60756090
expect(() => applyWebpackOptionsDefaults(withTrue)).not.toThrow();

‎test/Validation.test.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,7 @@ describe("Validation", () => {
851851
expect(msg).toMatchInlineSnapshot(`
852852
"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
853853
- configuration.optimization has an unknown property 'hashedModuleIds'. These properties are valid:
854-
object { avoidEntryIife?, checkWasmTypes?, chunkIds?, concatenateModules?, emitOnErrors?, flagIncludedChunks?, inlineExports?, innerGraph?, mangleExports?, mangleWasmImports?, mergeDuplicateChunks?, minimize?, minimizer?, moduleIds?, noEmitOnErrors?, nodeEnv?, portableRecords?, providedExports?, realContentHash?, removeAvailableModules?, removeEmptyChunks?, runtimeChunk?, sideEffects?, splitChunks?, usedExports? }
854+
object { avoidEntryIife?, checkWasmTypes?, chunkIds?, concatenateModules?, emitOnErrors?, flagIncludedChunks?, inlineExports?, innerGraph?, mangleExports?, mangleWasmImports?, mergeDuplicateChunks?, minimize?, minimizeOptions?, minimizer?, moduleIds?, noEmitOnErrors?, nodeEnv?, portableRecords?, providedExports?, realContentHash?, removeAvailableModules?, removeEmptyChunks?, runtimeChunk?, sideEffects?, splitChunks?, usedExports? }
855855
-> Enables/Disables integrated optimizations.
856856
Did you mean optimization.moduleIds: \\"hashed\\" (BREAKING CHANGE since webpack 5)?"
857857
`)
@@ -868,7 +868,7 @@ describe("Validation", () => {
868868
expect(msg).toMatchInlineSnapshot(`
869869
"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
870870
- configuration.optimization has an unknown property 'namedChunks'. These properties are valid:
871-
object { avoidEntryIife?, checkWasmTypes?, chunkIds?, concatenateModules?, emitOnErrors?, flagIncludedChunks?, inlineExports?, innerGraph?, mangleExports?, mangleWasmImports?, mergeDuplicateChunks?, minimize?, minimizer?, moduleIds?, noEmitOnErrors?, nodeEnv?, portableRecords?, providedExports?, realContentHash?, removeAvailableModules?, removeEmptyChunks?, runtimeChunk?, sideEffects?, splitChunks?, usedExports? }
871+
object { avoidEntryIife?, checkWasmTypes?, chunkIds?, concatenateModules?, emitOnErrors?, flagIncludedChunks?, inlineExports?, innerGraph?, mangleExports?, mangleWasmImports?, mergeDuplicateChunks?, minimize?, minimizeOptions?, minimizer?, moduleIds?, noEmitOnErrors?, nodeEnv?, portableRecords?, providedExports?, realContentHash?, removeAvailableModules?, removeEmptyChunks?, runtimeChunk?, sideEffects?, splitChunks?, usedExports? }
872872
-> Enables/Disables integrated optimizations.
873873
Did you mean optimization.chunkIds: \\"named\\" (BREAKING CHANGE since webpack 5)?"
874874
`)
@@ -885,7 +885,7 @@ describe("Validation", () => {
885885
expect(msg).toMatchInlineSnapshot(`
886886
"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
887887
- configuration.optimization has an unknown property 'occurrenceOrder'. These properties are valid:
888-
object { avoidEntryIife?, checkWasmTypes?, chunkIds?, concatenateModules?, emitOnErrors?, flagIncludedChunks?, inlineExports?, innerGraph?, mangleExports?, mangleWasmImports?, mergeDuplicateChunks?, minimize?, minimizer?, moduleIds?, noEmitOnErrors?, nodeEnv?, portableRecords?, providedExports?, realContentHash?, removeAvailableModules?, removeEmptyChunks?, runtimeChunk?, sideEffects?, splitChunks?, usedExports? }
888+
object { avoidEntryIife?, checkWasmTypes?, chunkIds?, concatenateModules?, emitOnErrors?, flagIncludedChunks?, inlineExports?, innerGraph?, mangleExports?, mangleWasmImports?, mergeDuplicateChunks?, minimize?, minimizeOptions?, minimizer?, moduleIds?, noEmitOnErrors?, nodeEnv?, portableRecords?, providedExports?, realContentHash?, removeAvailableModules?, removeEmptyChunks?, runtimeChunk?, sideEffects?, splitChunks?, usedExports? }
889889
-> Enables/Disables integrated optimizations.
890890
Did you mean optimization.chunkIds: \\"size\\" and optimization.moduleIds: \\"size\\" (BREAKING CHANGE since webpack 5)?"
891891
`)

0 commit comments

Comments
 (0)