webpack 5.97.1 → 5.104.1

package/lib/stats/DefaultStatsPresetPlugin.js

@@ -8,26 +8,30 @@
 const RequestShortener = require("../RequestShortener");
 
 /** @typedef {import("../../declarations/WebpackOptions").StatsOptions} StatsOptions */
+/** @typedef {import("../../declarations/WebpackOptions").StatsValue} StatsValue */
 /** @typedef {import("../Compilation")} Compilation */
 /** @typedef {import("../Compilation").CreateStatsOptionsContext} CreateStatsOptionsContext */
+/** @typedef {import("../Compilation").KnownNormalizedStatsOptions} KnownNormalizedStatsOptions */
+/** @typedef {import("../Compilation").NormalizedStatsOptions} NormalizedStatsOptions */
 /** @typedef {import("../Compiler")} Compiler */
 /** @typedef {import("./DefaultStatsFactoryPlugin").StatsError} StatsError */
 
 /**
- * @param {StatsOptions} options options
+ * @param {Partial<NormalizedStatsOptions>} options options
  * @param {StatsOptions} defaults default options
  */
 const applyDefaults = (options, defaults) => {
 	for (const _k of Object.keys(defaults)) {
 		const key = /** @type {keyof StatsOptions} */ (_k);
 		if (typeof options[key] === "undefined") {
-			/** @type {TODO} */
-			(options)[key] = defaults[key];
+			options[/** @type {keyof NormalizedStatsOptions} */ (key)] =
+				defaults[key];
 		}
 	}
 };
 
-/** @typedef {Record<string, StatsOptions>} NamedPresets */
+/** @typedef {{ [Key in Exclude<StatsValue, boolean | EXPECTED_OBJECT | "normal">]: StatsOptions }} NamedPresets */
+
 /** @type {NamedPresets} */
 const NAMED_PRESETS = {
 	verbose: {
@@ -51,6 +55,8 @@ const NAMED_PRESETS = {
 		optimizationBailout: true,
 		errorDetails: true,
 		errorStack: true,
+		errorCause: true,
+		errorErrors: true,
 		publicPath: true,
 		logging: "verbose",
 		orphanModules: true,
@@ -80,6 +86,8 @@ const NAMED_PRESETS = {
 		providedExports: true,
 		optimizationBailout: true,
 		errorDetails: true,
+		errorCause: true,
+		errorErrors: true,
 		publicPath: true,
 		logging: true,
 		runtimeModules: true,
@@ -136,31 +144,31 @@ const NAMED_PRESETS = {
 };
 
 /**
- * @param {StatsOptions} all stats option
+ * @param {Partial<NormalizedStatsOptions>} all stats options
  * @returns {boolean} true when enabled, otherwise false
  */
 const NORMAL_ON = ({ all }) => all !== false;
 /**
- * @param {StatsOptions} all stats option
+ * @param {Partial<NormalizedStatsOptions>} all stats options
  * @returns {boolean} true when enabled, otherwise false
  */
 const NORMAL_OFF = ({ all }) => all === true;
 /**
- * @param {StatsOptions} all stats option
+ * @param {Partial<NormalizedStatsOptions>} all stats options
  * @param {CreateStatsOptionsContext} forToString stats options context
  * @returns {boolean} true when enabled, otherwise false
  */
 const ON_FOR_TO_STRING = ({ all }, { forToString }) =>
 	forToString ? all !== false : all === true;
 /**
- * @param {StatsOptions} all stats option
+ * @param {Partial<NormalizedStatsOptions>} all stats options
  * @param {CreateStatsOptionsContext} forToString stats options context
  * @returns {boolean} true when enabled, otherwise false
  */
 const OFF_FOR_TO_STRING = ({ all }, { forToString }) =>
 	forToString ? all === true : all !== false;
 /**
- * @param {StatsOptions} all stats option
+ * @param {Partial<NormalizedStatsOptions>} all stats options
  * @param {CreateStatsOptionsContext} forToString stats options context
  * @returns {boolean | "auto"} true when enabled, otherwise false
  */
@@ -171,7 +179,8 @@ const AUTO_FOR_TO_STRING = ({ all }, { forToString }) => {
 	return true;
 };
 
-/** @typedef {Record<string, (options: StatsOptions, context: CreateStatsOptionsContext, compilation: Compilation) => StatsOptions[keyof StatsOptions] | RequestShortener>} Defaults */
+/** @typedef {keyof NormalizedStatsOptions} DefaultsKeys */
+/** @typedef {{ [Key in DefaultsKeys]: (options: Partial<NormalizedStatsOptions>, context: CreateStatsOptionsContext, compilation: Compilation) => NormalizedStatsOptions[Key] | RequestShortener }} Defaults */
 
 /** @type {Defaults} */
 const DEFAULTS = {
@@ -255,6 +264,8 @@ const DEFAULTS = {
 	errorsCount: NORMAL_ON,
 	errorDetails: AUTO_FOR_TO_STRING,
 	errorStack: OFF_FOR_TO_STRING,
+	errorCause: AUTO_FOR_TO_STRING,
+	errorErrors: AUTO_FOR_TO_STRING,
 	warnings: NORMAL_ON,
 	warningsCount: NORMAL_ON,
 	publicPath: OFF_FOR_TO_STRING,
@@ -274,57 +285,68 @@ const DEFAULTS = {
 };
 
 /**
- * @param {string | ({ test: function(string): boolean }) | (function(string): boolean) | boolean} item item to normalize
- * @returns {(function(string): boolean) | undefined} normalize fn
+ * @template T
+ * @typedef {(value: T, ...args: EXPECTED_ANY[]) => boolean} NormalizeFunction
+ */
+
+/**
+ * @template {string} T
+ * @param {string | ({ test: (value: T) => boolean }) | NormalizeFunction<T> | boolean} item item to normalize
+ * @returns {NormalizeFunction<T>} normalize fn
  */
-const normalizeFilter = item => {
+const normalizeFilter = (item) => {
 	if (typeof item === "string") {
 		const regExp = new RegExp(
 			`[\\\\/]${item.replace(/[-[\]{}()*+?.\\^$|]/g, "\\$&")}([\\\\/]|$|!|\\?)`
 		);
-		return ident => regExp.test(ident);
+		return (ident) => regExp.test(/** @type {T} */ (ident));
 	}
 	if (item && typeof item === "object" && typeof item.test === "function") {
-		return ident => item.test(ident);
-	}
-	if (typeof item === "function") {
-		return item;
+		return (ident) => item.test(ident);
 	}
 	if (typeof item === "boolean") {
 		return () => item;
 	}
+
+	return /** @type {NormalizeFunction<T>} */ (item);
 };
 
-/** @type {Record<string, function(any): any[]>} */
+/** @typedef {keyof (KnownNormalizedStatsOptions | StatsOptions)} NormalizerKeys */
+/** @typedef {{ [Key in NormalizerKeys]?: (value: StatsOptions[Key]) => KnownNormalizedStatsOptions[Key] }} Normalizers */
+
+/**
+ * @callback WarningFilterFn
+ * @param {StatsError} warning warning
+ * @param {string} warningString warning string
+ * @returns {boolean} result
+ */
+
+/** @type {Normalizers} */
 const NORMALIZER = {
-	excludeModules: value => {
+	excludeModules: (value) => {
 		if (!Array.isArray(value)) {
-			value = value ? [value] : [];
+			value = value
+				? /** @type {KnownNormalizedStatsOptions["excludeModules"]} */ ([value])
+				: [];
 		}
 		return value.map(normalizeFilter);
 	},
-	excludeAssets: value => {
+	excludeAssets: (value) => {
 		if (!Array.isArray(value)) {
 			value = value ? [value] : [];
 		}
 		return value.map(normalizeFilter);
 	},
-	warningsFilter: value => {
+	warningsFilter: (value) => {
 		if (!Array.isArray(value)) {
 			value = value ? [value] : [];
 		}
-		/**
-		 * @callback WarningFilterFn
-		 * @param {StatsError} warning warning
-		 * @param {string} warningString warning string
-		 * @returns {boolean} result
-		 */
 		return value.map(
 			/**
 			 * @param {StatsOptions["warningsFilter"]} filter a warning filter
 			 * @returns {WarningFilterFn} result
 			 */
-			filter => {
+			(filter) => {
 				if (typeof filter === "string") {
 					return (warning, warningString) => warningString.includes(filter);
 				}
@@ -340,18 +362,22 @@ const NORMALIZER = {
 			}
 		);
 	},
-	logging: value => {
+	logging: (value) => {
 		if (value === true) value = "log";
-		return value;
+		return /** @type {KnownNormalizedStatsOptions["logging"]} */ (value);
 	},
-	loggingDebug: value => {
+	loggingDebug: (value) => {
 		if (!Array.isArray(value)) {
-			value = value ? [value] : [];
+			value = value
+				? /** @type {KnownNormalizedStatsOptions["loggingDebug"]} */ ([value])
+				: [];
 		}
 		return value.map(normalizeFilter);
 	}
 };
 
+const PLUGIN_NAME = "DefaultStatsPresetPlugin";
+
 class DefaultStatsPresetPlugin {
 	/**
 	 * Apply the plugin
@@ -359,28 +385,33 @@ class DefaultStatsPresetPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		compiler.hooks.compilation.tap("DefaultStatsPresetPlugin", compilation => {
+		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
 			for (const key of Object.keys(NAMED_PRESETS)) {
 				const defaults = NAMED_PRESETS[/** @type {keyof NamedPresets} */ (key)];
 				compilation.hooks.statsPreset
 					.for(key)
-					.tap("DefaultStatsPresetPlugin", (options, context) => {
+					.tap(PLUGIN_NAME, (options, _context) => {
 						applyDefaults(options, defaults);
 					});
 			}
-			compilation.hooks.statsNormalize.tap(
-				"DefaultStatsPresetPlugin",
-				(options, context) => {
-					for (const key of Object.keys(DEFAULTS)) {
-						if (options[key] === undefined)
-							options[key] = DEFAULTS[key](options, context, compilation);
-					}
-					for (const key of Object.keys(NORMALIZER)) {
-						options[key] = NORMALIZER[key](options[key]);
+			compilation.hooks.statsNormalize.tap(PLUGIN_NAME, (options, context) => {
+				for (const key of Object.keys(DEFAULTS)) {
+					if (options[key] === undefined) {
+						options[key] = DEFAULTS[/** @type {DefaultsKeys} */ (key)](
+							options,
+							context,
+							compilation
+						);
 					}
 				}
-			);
+				for (const key of Object.keys(NORMALIZER)) {
+					options[key] =
+						/** @type {NonNullable<Normalizers[keyof Normalizers]>} */
+						(NORMALIZER[/** @type {NormalizerKeys} */ (key)])(options[key]);
+				}
+			});
 		});
 	}
 }
+
 module.exports = DefaultStatsPresetPlugin;