webpack 5.97.1 → 5.104.1

package/lib/stats/StatsFactory.js

@@ -10,34 +10,70 @@ const { concatComparators, keepOriginalOrder } = require("../util/comparators");
 const smartGrouping = require("../util/smartGrouping");
 
 /** @typedef {import("../Chunk")} Chunk */
+/** @typedef {import("../ChunkGroup").OriginRecord} OriginRecord */
 /** @typedef {import("../Compilation")} Compilation */
+/** @typedef {import("../Compilation").Asset} Asset */
 /** @typedef {import("../Compilation").NormalizedStatsOptions} NormalizedStatsOptions */
+/** @typedef {import("../Dependency")} Dependency */
 /** @typedef {import("../Module")} Module */
+/** @typedef {import("../ModuleGraph").ModuleProfile} ModuleProfile */
+/** @typedef {import("../ModuleGraphConnection")} ModuleGraphConnection */
 /** @typedef {import("../WebpackError")} WebpackError */
-/** @typedef {import("../util/comparators").Comparator<any>} Comparator */
+/** @typedef {import("../util/comparators").Comparator<EXPECTED_ANY>} Comparator */
 /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
-/** @typedef {import("../util/smartGrouping").GroupConfig<any, object>} GroupConfig */
+/**
+ * @template T, R
+ * @typedef {import("../util/smartGrouping").GroupConfig<T, R>} GroupConfig
+ */
+/** @typedef {import("./DefaultStatsFactoryPlugin").ChunkGroupInfoWithName} ChunkGroupInfoWithName */
+/** @typedef {import("./DefaultStatsFactoryPlugin").ModuleIssuerPath} ModuleIssuerPath */
+/** @typedef {import("./DefaultStatsFactoryPlugin").ModuleTrace} ModuleTrace */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsAsset} StatsAsset */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsChunk} StatsChunk */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsChunkGroup} StatsChunkGroup */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsChunkOrigin} StatsChunkOrigin */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsCompilation} StatsCompilation */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsError} StatsError */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsModule} StatsModule */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsModuleIssuer} StatsModuleIssuer */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsModuleReason} StatsModuleReason */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsModuleTraceDependency} StatsModuleTraceDependency */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsModuleTraceItem} StatsModuleTraceItem */
+/** @typedef {import("./DefaultStatsFactoryPlugin").StatsProfile} StatsProfile */
 
 /**
  * @typedef {object} KnownStatsFactoryContext
  * @property {string} type
- * @property {function(string): string} makePathsRelative
  * @property {Compilation} compilation
+ * @property {(path: string) => string} makePathsRelative
  * @property {Set<Module>} rootModules
- * @property {Map<string,Chunk[]>} compilationFileToChunks
- * @property {Map<string,Chunk[]>} compilationAuxiliaryFileToChunks
+ * @property {Map<string, Chunk[]>} compilationFileToChunks
+ * @property {Map<string, Chunk[]>} compilationAuxiliaryFileToChunks
  * @property {RuntimeSpec} runtime
- * @property {function(Compilation): WebpackError[]} cachedGetErrors
- * @property {function(Compilation): WebpackError[]} cachedGetWarnings
+ * @property {(compilation: Compilation) => Error[]} cachedGetErrors
+ * @property {(compilation: Compilation) => Error[]} cachedGetWarnings
  */
 
-/** @typedef {Record<string, any> & KnownStatsFactoryContext} StatsFactoryContext */
+/** @typedef {KnownStatsFactoryContext & Record<string, EXPECTED_ANY>} StatsFactoryContext */
 
-/** @typedef {any} CreatedObject */
-/** @typedef {any} FactoryData */
-/** @typedef {any} FactoryDataItem */
-/** @typedef {any} Result */
-/** @typedef {Record<string, any>} ObjectForExtract */
+// StatsLogging StatsLoggingEntry
+
+/**
+ * @template T
+ * @template F
+ * @typedef {T extends Compilation ? StatsCompilation : T extends ChunkGroupInfoWithName ? StatsChunkGroup : T extends Chunk ? StatsChunk : T extends OriginRecord ? StatsChunkOrigin : T extends Module ? StatsModule : T extends ModuleGraphConnection ? StatsModuleReason : T extends Asset ? StatsAsset : T extends ModuleTrace ? StatsModuleTraceItem : T extends Dependency ? StatsModuleTraceDependency : T extends Error ? StatsError : T extends ModuleProfile ? StatsProfile : F} StatsObject
+ */
+
+/**
+ * @template T
+ * @template F
+ * @typedef {T extends ChunkGroupInfoWithName[] ? Record<string, StatsObject<ChunkGroupInfoWithName, F>> : T extends (infer V)[] ? StatsObject<V, F>[] : StatsObject<T, F>} CreatedObject
+ */
+
+/** @typedef {EXPECTED_ANY} ObjectForExtract */
+/** @typedef {EXPECTED_ANY} FactoryData */
+/** @typedef {EXPECTED_ANY} FactoryDataItem */
+/** @typedef {EXPECTED_ANY} Result */
 
 /**
  * @typedef {object} StatsFactoryHooks
@@ -45,7 +81,7 @@ const smartGrouping = require("../util/smartGrouping");
  * @property {HookMap<SyncBailHook<[FactoryDataItem, StatsFactoryContext, number, number], boolean | void>>} filter
  * @property {HookMap<SyncBailHook<[Comparator[], StatsFactoryContext], void>>} sort
  * @property {HookMap<SyncBailHook<[FactoryDataItem, StatsFactoryContext, number, number], boolean | void>>} filterSorted
- * @property {HookMap<SyncBailHook<[GroupConfig[], StatsFactoryContext], void>>} groupResults
+ * @property {HookMap<SyncBailHook<[GroupConfig<EXPECTED_ANY, EXPECTED_ANY>[], StatsFactoryContext], void>>} groupResults
  * @property {HookMap<SyncBailHook<[Comparator[], StatsFactoryContext], void>>} sortResults
  * @property {HookMap<SyncBailHook<[FactoryDataItem, StatsFactoryContext, number, number], boolean | void>>} filterResults
  * @property {HookMap<SyncBailHook<[FactoryDataItem[], StatsFactoryContext], Result | void>>} merge
@@ -88,7 +124,8 @@ class StatsFactory {
 			getItemFactory: new HookMap(() => new SyncBailHook(["item", "context"]))
 		});
 		const hooks = this.hooks;
-		this._caches = /** @type {TODO} */ ({});
+		this._caches =
+			/** @type {{ [Key in keyof StatsFactoryHooks]: Map<string, SyncBailHook<EXPECTED_ANY, EXPECTED_ANY>[]> }} */ ({});
 		for (const key of Object.keys(hooks)) {
 			this._caches[/** @type {keyof StatsFactoryHooks} */ (key)] = new Map();
 		}
@@ -128,7 +165,7 @@ class StatsFactory {
 	 * @param {HM} hookMap hook map
 	 * @param {Caches<H>} cache cache
 	 * @param {string} type type
-	 * @param {function(H): R | void} fn fn
+	 * @param {(hook: H) => R | void} fn fn
 	 * @returns {R | void} hook
 	 * @private
 	 */
@@ -146,7 +183,7 @@ class StatsFactory {
 	 * @param {Caches<H>} cache cache
 	 * @param {string} type type
 	 * @param {FactoryData} data data
-	 * @param {function(H, FactoryData): FactoryData} fn fn
+	 * @param {(hook: H, factoryData: FactoryData) => FactoryData} fn fn
 	 * @returns {FactoryData} data
 	 * @private
 	 */
@@ -164,15 +201,15 @@ class StatsFactory {
 	 * @param {T} hookMap hook map
 	 * @param {Caches<H>} cache cache
 	 * @param {string} type type
-	 * @param {Array<FactoryData>} items items
-	 * @param {function(H, R, number, number): R | undefined} fn fn
+	 * @param {FactoryData[]} items items
+	 * @param {(hook: H, item: R, idx: number, i: number) => R | undefined} fn fn
 	 * @param {boolean} forceClone force clone
 	 * @returns {R[]} result for each level
 	 * @private
 	 */
 	_forEachLevelFilter(hookMap, cache, type, items, fn, forceClone) {
 		const hooks = this._getAllLevelHooks(hookMap, cache, type);
-		if (hooks.length === 0) return forceClone ? items.slice() : items;
+		if (hooks.length === 0) return forceClone ? [...items] : items;
 		let i = 0;
 		return items.filter((item, idx) => {
 			for (const hook of hooks) {
@@ -188,10 +225,12 @@ class StatsFactory {
 	}
 
 	/**
+	 * @template FactoryData
+	 * @template FallbackCreatedObject
 	 * @param {string} type type
 	 * @param {FactoryData} data factory data
 	 * @param {Omit<StatsFactoryContext, "type">} baseContext context used as base
-	 * @returns {CreatedObject} created object
+	 * @returns {CreatedObject<FactoryData, FallbackCreatedObject>} created object
 	 */
 	create(type, data, baseContext) {
 		if (this._inCreate) {
@@ -201,18 +240,21 @@ class StatsFactory {
 			this._inCreate = true;
 			return this._create(type, data, baseContext);
 		} finally {
-			for (const key of Object.keys(this._caches))
+			for (const key of Object.keys(this._caches)) {
 				this._caches[/** @type {keyof StatsFactoryHooks} */ (key)].clear();
+			}
 			this._inCreate = false;
 		}
 	}
 
 	/**
+	 * @private
+	 * @template FactoryData
+	 * @template FallbackCreatedObject
 	 * @param {string} type type
 	 * @param {FactoryData} data factory data
 	 * @param {Omit<StatsFactoryContext, "type">} baseContext context used as base
-	 * @returns {CreatedObject} created object
-	 * @private
+	 * @returns {CreatedObject<FactoryData, FallbackCreatedObject>} created object
 	 */
 	_create(type, data, baseContext) {
 		const context = /** @type {StatsFactoryContext} */ ({
@@ -234,7 +276,7 @@ class StatsFactory {
 			// sort items
 			/** @type {Comparator[]} */
 			const comparators = [];
-			this._forEachLevel(this.hooks.sort, this._caches.sort, type, h =>
+			this._forEachLevel(this.hooks.sort, this._caches.sort, type, (h) =>
 				h.call(comparators, context)
 			);
 			if (comparators.length > 0) {
@@ -267,7 +309,7 @@ class StatsFactory {
 					this.hooks.getItemName,
 					this._caches.getItemName,
 					`${type}[]`,
-					h => h.call(item, itemContext)
+					(h) => h.call(item, itemContext)
 				);
 				if (itemName) itemContext[itemName] = item;
 				const innerType = itemName ? `${type}[].${itemName}` : `${type}[]`;
@@ -278,7 +320,7 @@ class StatsFactory {
 						this.hooks.getItemFactory,
 						this._caches.getItemFactory,
 						innerType,
-						h => h.call(item, itemContext)
+						(h) => h.call(item, itemContext)
 					) || this;
 
 				// run item factory
@@ -292,7 +334,7 @@ class StatsFactory {
 				this.hooks.sortResults,
 				this._caches.sortResults,
 				type,
-				h => h.call(comparators2, context)
+				(h) => h.call(comparators2, context)
 			);
 			if (comparators2.length > 0) {
 				resultItems.sort(
@@ -302,13 +344,13 @@ class StatsFactory {
 			}
 
 			// group result items
-			/** @type {GroupConfig[]} */
+			/** @type {GroupConfig<EXPECTED_ANY, EXPECTED_ANY>[]} */
 			const groupConfigs = [];
 			this._forEachLevel(
 				this.hooks.groupResults,
 				this._caches.groupResults,
 				type,
-				h => h.call(groupConfigs, context)
+				(h) => h.call(groupConfigs, context)
 			);
 			if (groupConfigs.length > 0) {
 				resultItems = smartGrouping(resultItems, groupConfigs);
@@ -329,7 +371,7 @@ class StatsFactory {
 				this.hooks.merge,
 				this._caches.merge,
 				type,
-				h => h.call(finalResultItems, context)
+				(h) => h.call(finalResultItems, context)
 			);
 			if (result === undefined) result = finalResultItems;
 
@@ -346,7 +388,7 @@ class StatsFactory {
 		const object = {};
 
 		// run extract on value
-		this._forEachLevel(this.hooks.extract, this._caches.extract, type, h =>
+		this._forEachLevel(this.hooks.extract, this._caches.extract, type, (h) =>
 			h.call(object, data, context)
 		);
 
@@ -360,4 +402,5 @@ class StatsFactory {
 		);
 	}
 }
+
 module.exports = StatsFactory;

package/lib/stats/StatsPrinter.js

@@ -5,7 +5,7 @@
 
 "use strict";
 
-const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable");
+const { HookMap, SyncBailHook, SyncWaterfallHook } = require("tapable");
 
 /** @typedef {import("./DefaultStatsFactoryPlugin").StatsAsset} StatsAsset */
 /** @typedef {import("./DefaultStatsFactoryPlugin").StatsChunk} StatsChunk */
@@ -23,7 +23,7 @@ const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable");
 /**
  * @typedef {object} PrintedElement
  * @property {string} element
- * @property {string} content
+ * @property {string | undefined} content
  */
 
 /**
@@ -44,21 +44,23 @@ const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable");
  * @property {StatsModuleTraceDependency=} moduleTraceDependency
  */
 
+/** @typedef {(value: string | number) => string} ColorFunction */
+
 /**
- * @typedef {object} KnownStatsPrinterColorFn
- * @property {(str: string) => string=} bold
- * @property {(str: string) => string=} yellow
- * @property {(str: string) => string=} red
- * @property {(str: string) => string=} green
- * @property {(str: string) => string=} magenta
- * @property {(str: string) => string=} cyan
+ * @typedef {object} KnownStatsPrinterColorFunctions
+ * @property {ColorFunction=} bold
+ * @property {ColorFunction=} yellow
+ * @property {ColorFunction=} red
+ * @property {ColorFunction=} green
+ * @property {ColorFunction=} magenta
+ * @property {ColorFunction=} cyan
  */
 
 /**
- * @typedef {object} KnownStatsPrinterFormaters
+ * @typedef {object} KnownStatsPrinterFormatters
  * @property {(file: string, oversize?: boolean) => string=} formatFilename
- * @property {(id: string) => string=} formatModuleId
- * @property {(id: string, direction?: "parent"|"child"|"sibling") => string=} formatChunkId
+ * @property {(id: string | number) => string=} formatModuleId
+ * @property {(id: string | number, direction?: "parent" | "child" | "sibling") => string=} formatChunkId
  * @property {(size: number) => string=} formatSize
  * @property {(size: string) => string=} formatLayer
  * @property {(dateTime: number) => string=} formatDateTime
@@ -67,17 +69,18 @@ const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable");
  * @property {(message: string) => string=} formatError
  */
 
-/** @typedef {Record<string, EXPECTED_ANY> & KnownStatsPrinterColorFn & KnownStatsPrinterFormaters & KnownStatsPrinterContext} StatsPrinterContext */
-/** @typedef {any} PrintObject */
+/** @typedef {KnownStatsPrinterColorFunctions & KnownStatsPrinterFormatters & KnownStatsPrinterContext & Record<string, EXPECTED_ANY>} StatsPrinterContext */
+/** @typedef {StatsPrinterContext & Required<KnownStatsPrinterColorFunctions> & Required<KnownStatsPrinterFormatters> & { type: string }} StatsPrinterContextWithExtra */
+/** @typedef {EXPECTED_ANY} PrintObject */
 
 /**
  * @typedef {object} StatsPrintHooks
  * @property {HookMap<SyncBailHook<[string[], StatsPrinterContext], void>>} sortElements
- * @property {HookMap<SyncBailHook<[PrintedElement[], StatsPrinterContext], string | void>>} printElements
+ * @property {HookMap<SyncBailHook<[PrintedElement[], StatsPrinterContext], string | undefined | void>>} printElements
  * @property {HookMap<SyncBailHook<[PrintObject[], StatsPrinterContext], boolean | void>>} sortItems
  * @property {HookMap<SyncBailHook<[PrintObject, StatsPrinterContext], string | void>>} getItemName
- * @property {HookMap<SyncBailHook<[string[], StatsPrinterContext], string | void>>} printItems
- * @property {HookMap<SyncBailHook<[PrintObject, StatsPrinterContext], string | void>>} print
+ * @property {HookMap<SyncBailHook<[string[], StatsPrinterContext], string | undefined>>} printItems
+ * @property {HookMap<SyncBailHook<[PrintObject, StatsPrinterContext], string | undefined | void>>} print
  * @property {HookMap<SyncWaterfallHook<[string, StatsPrinterContext]>>} result
  */
 
@@ -97,12 +100,9 @@ class StatsPrinter {
 				() => new SyncBailHook(["printedItems", "context"])
 			),
 			print: new HookMap(() => new SyncBailHook(["object", "context"])),
-			/** @type {HookMap<SyncWaterfallHook<[string, StatsPrinterContext]>>} */
 			result: new HookMap(() => new SyncWaterfallHook(["result", "context"]))
 		});
-		/**
-		 * @type {TODO}
-		 */
+		/** @type {Map<StatsPrintHooks[keyof StatsPrintHooks], Map<string, import("tapable").Hook<EXPECTED_ANY, EXPECTED_ANY>[]>>} */
 		this._levelHookCache = new Map();
 		this._inPrint = false;
 	}
@@ -124,7 +124,7 @@ class StatsPrinter {
 		}
 		const cacheEntry = cache.get(type);
 		if (cacheEntry !== undefined) {
-			return cacheEntry;
+			return /** @type {H[]} */ (cacheEntry);
 		}
 		/** @type {H[]} */
 		const hooks = [];
@@ -144,16 +144,16 @@ class StatsPrinter {
 	 * @private
 	 * @template {StatsPrintHooks[keyof StatsPrintHooks]} HM
 	 * @template {HM extends HookMap<infer H> ? H : never} H
-	 * @template {H extends import("tapable").Hook<any, infer R> ? R : never} R
+	 * @template {H extends import("tapable").Hook<EXPECTED_ANY, infer R> ? R : never} R
 	 * @param {HM} hookMap hook map
 	 * @param {string} type type
-	 * @param {function(H): R | void} fn fn
-	 * @returns {R | void} hook
+	 * @param {(hooK: H) => R | undefined | void} fn fn
+	 * @returns {R | undefined} hook
 	 */
 	_forEachLevel(hookMap, type, fn) {
 		for (const hook of this._getAllLevelHooks(hookMap, type)) {
 			const result = fn(/** @type {H} */ (hook));
-			if (result !== undefined) return result;
+			if (result !== undefined) return /** @type {R} */ (result);
 		}
 	}
 
@@ -165,8 +165,8 @@ class StatsPrinter {
 	 * @param {HM} hookMap hook map
 	 * @param {string} type type
 	 * @param {string} data data
-	 * @param {function(H, string): string} fn fn
-	 * @returns {string} result of `fn`
+	 * @param {(hook: H, data: string) => string} fn fn
+	 * @returns {string | undefined} result of `fn`
 	 */
 	_forEachLevelWaterfall(hookMap, type, data, fn) {
 		for (const hook of this._getAllLevelHooks(hookMap, type)) {
@@ -179,7 +179,7 @@ class StatsPrinter {
 	 * @param {string} type The type
 	 * @param {PrintObject} object Object to print
 	 * @param {StatsPrinterContext=} baseContext The base context
-	 * @returns {string} printed result
+	 * @returns {string | undefined} printed result
 	 */
 	print(type, object, baseContext) {
 		if (this._inPrint) {
@@ -199,7 +199,7 @@ class StatsPrinter {
 	 * @param {string} type type
 	 * @param {PrintObject} object object
 	 * @param {StatsPrinterContext=} baseContext context
-	 * @returns {string} printed result
+	 * @returns {string | undefined} printed result
 	 */
 	_print(type, object, baseContext) {
 		/** @type {StatsPrinterContext} */
@@ -209,25 +209,31 @@ class StatsPrinter {
 			[type]: object
 		};
 
-		let printResult = this._forEachLevel(this.hooks.print, type, hook =>
+		/** @type {string | undefined} */
+		let printResult = this._forEachLevel(this.hooks.print, type, (hook) =>
 			hook.call(object, context)
 		);
 		if (printResult === undefined) {
 			if (Array.isArray(object)) {
-				const sortedItems = object.slice();
-				this._forEachLevel(this.hooks.sortItems, type, h =>
-					h.call(sortedItems, context)
+				const sortedItems = [...object];
+				this._forEachLevel(this.hooks.sortItems, type, (h) =>
+					h.call(
+						sortedItems,
+						/** @type {StatsPrinterContextWithExtra} */
+						(context)
+					)
 				);
 				const printedItems = sortedItems.map((item, i) => {
-					/** @type {StatsPrinterContext} */
-					const itemContext = {
-						...context,
-						_index: i
-					};
+					const itemContext =
+						/** @type {StatsPrinterContextWithExtra} */
+						({
+							...context,
+							_index: i
+						});
 					const itemName = this._forEachLevel(
 						this.hooks.getItemName,
 						`${type}[]`,
-						h => h.call(item, itemContext)
+						(h) => h.call(item, itemContext)
 					);
 					if (itemName) itemContext[itemName] = item;
 					return this.print(
@@ -236,8 +242,12 @@ class StatsPrinter {
 						itemContext
 					);
 				});
-				printResult = this._forEachLevel(this.hooks.printItems, type, h =>
-					h.call(printedItems, context)
+				printResult = this._forEachLevel(this.hooks.printItems, type, (h) =>
+					h.call(
+						/** @type {string[]} */ (printedItems),
+						/** @type {StatsPrinterContextWithExtra} */
+						(context)
+					)
 				);
 				if (printResult === undefined) {
 					const result = printedItems.filter(Boolean);
@@ -245,12 +255,16 @@ class StatsPrinter {
 				}
 			} else if (object !== null && typeof object === "object") {
 				const elements = Object.keys(object).filter(
-					key => object[key] !== undefined
+					(key) => object[key] !== undefined
 				);
-				this._forEachLevel(this.hooks.sortElements, type, h =>
-					h.call(elements, context)
+				this._forEachLevel(this.hooks.sortElements, type, (h) =>
+					h.call(
+						elements,
+						/** @type {StatsPrinterContextWithExtra} */
+						(context)
+					)
 				);
-				const printedElements = elements.map(element => {
+				const printedElements = elements.map((element) => {
 					const content = this.print(`${type}.${element}`, object[element], {
 						...context,
 						_parent: object,
@@ -259,11 +273,15 @@ class StatsPrinter {
 					});
 					return { element, content };
 				});
-				printResult = this._forEachLevel(this.hooks.printElements, type, h =>
-					h.call(printedElements, context)
+				printResult = this._forEachLevel(this.hooks.printElements, type, (h) =>
+					h.call(
+						printedElements,
+						/** @type {StatsPrinterContextWithExtra} */
+						(context)
+					)
 				);
 				if (printResult === undefined) {
-					const result = printedElements.map(e => e.content).filter(Boolean);
+					const result = printedElements.map((e) => e.content).filter(Boolean);
 					if (result.length > 0) printResult = result.join("\n");
 				}
 			}
@@ -272,9 +290,11 @@ class StatsPrinter {
 		return this._forEachLevelWaterfall(
 			this.hooks.result,
 			type,
-			/** @type {string} */ (printResult),
-			(h, r) => h.call(r, context)
+			/** @type {string} */
+			(printResult),
+			(h, r) => h.call(r, /** @type {StatsPrinterContextWithExtra} */ (context))
 		);
 	}
 }
+
 module.exports = StatsPrinter;