webpack 5.106.1 → 5.106.2

package/lib/stats/DefaultStatsPrinterPlugin.js

@@ -36,6 +36,7 @@ const DATA_URI_CONTENT_LENGTH = 16;
 const MAX_MODULE_IDENTIFIER_LENGTH = 80;
 
 /**
+ * Returns if n is 1, singular, else plural.
  * @param {number} n a number
  * @param {string} singular singular
  * @param {string} plural plural
@@ -44,6 +45,7 @@ const MAX_MODULE_IDENTIFIER_LENGTH = 80;
 const plural = (n, singular, plural) => (n === 1 ? singular : plural);
 
 /**
+ * Returns text.
  * @param {Record<string, number>} sizes sizes by source type
  * @param {StatsPrinterContext} options options
  * @returns {string | undefined} text
@@ -58,6 +60,7 @@ const printSizes = (sizes, { formatSize = (n) => `${n}` }) => {
 };
 
 /**
+ * Gets resource name.
  * @param {string | null} resource resource
  * @returns {string} resource name for display
  */
@@ -75,6 +78,7 @@ const getResourceName = (resource) => {
 };
 
 /**
+ * Returns prefix and module name.
  * @param {string} name module name
  * @returns {[string, string]} prefix and module name
  */
@@ -99,6 +103,7 @@ const getModuleName = (name) => {
 };
 
 /**
+ * Returns joined string.
  * @param {string} str string
  * @param {(item: string) => string} fn function to apply to each line
  * @returns {string} joined string
@@ -106,12 +111,14 @@ const getModuleName = (name) => {
 const mapLines = (str, fn) => str.split("\n").map(fn).join("\n");
 
 /**
+ * Returns number as two digit string, leading 0.
  * @param {number} n a number
  * @returns {string} number as two digit string, leading 0
  */
 const twoDigit = (n) => (n >= 10 ? `${n}` : `0${n}`);
 
 /**
+ * Checks whether this object is valid id.
  * @param {string | number | null} id an id
  * @returns {id is string | number} is i
  */
@@ -124,6 +131,7 @@ const isValidId = (id) => {
 };
 
 /**
+ * Returns string representation of list.
  * @template T
  * @param {T[] | undefined} list of items
  * @param {number} count number of items to show
@@ -133,28 +141,33 @@ const moreCount = (list, count) =>
 	list && list.length > 0 ? `+ ${count}` : `${count}`;
 
 /**
+ * Defines the with required type used by this module.
  * @template T
  * @template {keyof T} K
  * @typedef {{ [P in K]-?: T[P] }} WithRequired
  */
 
 /**
+ * Defines the define stats printer context type used by this module.
  * @template {keyof StatsPrinterContext} RequiredStatsPrinterContextKeys
  * @typedef {StatsPrinterContextWithExtra & WithRequired<StatsPrinterContext, "compilation" | RequiredStatsPrinterContextKeys>} DefineStatsPrinterContext
  */
 
 /**
+ * Defines the simple printer type used by this module.
  * @template T
  * @template {keyof StatsPrinterContext} RequiredStatsPrinterContextKeys
  * @typedef {(thing: Exclude<T, undefined>, context: DefineStatsPrinterContext<RequiredStatsPrinterContextKeys>, printer: StatsPrinter) => string | undefined} SimplePrinter
  */
 
 /**
+ * Defines the unpacked type used by this module.
  * @template T
  * @typedef {T extends (infer U)[] ? U : T} Unpacked
  */
 
 /**
+ * Defines the property name type used by this module.
  * @template {object} O
  * @template {keyof O} K
  * @template {string} B
@@ -162,6 +175,7 @@ const moreCount = (list, count) =>
  */
 
 /**
+ * Defines the array property name type used by this module.
  * @template {object} O
  * @template {keyof O} K
  * @template {string} B
@@ -169,6 +183,7 @@ const moreCount = (list, count) =>
  */
 
 /**
+ * Defines the exclamation type used by this module.
  * @template {object} O
  * @template {string} K
  * @template {string} E
@@ -176,6 +191,7 @@ const moreCount = (list, count) =>
  */
 
 /**
+ * Defines the shared type used by this module.
  * @template {object} O
  * @template {string} B
  * @template {string} [R=B]
@@ -184,6 +200,7 @@ const moreCount = (list, count) =>
  */
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Printers<KnownStatsCompilation, "compilation"> &
  * { ["compilation.summary!"]?: SimplePrinter<KnownStatsCompilation, "compilation"> } &
  * { ["compilation.errorsInChildren!"]?: SimplePrinter<KnownStatsCompilation, "compilation"> } &
@@ -406,6 +423,7 @@ const COMPILATION_SIMPLE_PRINTERS = {
 };
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Printers<KnownStatsAsset, "asset"> &
  * Printers<KnownStatsAsset["info"], "asset.info"> &
  * Exclamation<KnownStatsAsset, "asset.separator", "asset"> &
@@ -467,6 +485,7 @@ const ASSET_SIMPLE_PRINTERS = {
 };
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Printers<KnownStatsModule, "module"> &
  * Exclamation<KnownStatsModule, "module.separator", "module"> &
  * { ["module.filteredChildren"]?: SimplePrinter<number, "module"> } &
@@ -588,6 +607,7 @@ const MODULE_SIMPLE_PRINTERS = {
 };
 
 /**
+ * Defines the module issuer printers type used by this module.
  * @typedef {Printers<KnownStatsModuleIssuer, "moduleIssuer"> & Printers<KnownStatsModuleIssuer["profile"], "moduleIssuer.profile", "moduleIssuer">} ModuleIssuerPrinters
  */
 
@@ -598,6 +618,7 @@ const MODULE_ISSUER_PRINTERS = {
 };
 
 /**
+ * Defines the module reasons printers type used by this module.
  * @typedef {Printers<KnownStatsModuleReason, "moduleReason"> & { ["moduleReason.filteredChildren"]?: SimplePrinter<number, "moduleReason"> }} ModuleReasonsPrinters
  */
 
@@ -652,6 +673,7 @@ const MODULE_PROFILE_PRINTERS = {
 };
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Exclamation<KnownStatsChunkGroup, "chunkGroup.kind", "chunkGroupKind"> &
  * Exclamation<KnownStatsChunkGroup, "chunkGroup.separator", "chunkGroup"> &
  * Printers<KnownStatsChunkGroup, "chunkGroup"> &
@@ -716,6 +738,7 @@ const CHUNK_GROUP_PRINTERS = {
 };
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Printers<KnownStatsChunk, "chunk"> &
  * { ["chunk.childrenByOrder[].type"]: SimplePrinter<string, "chunk"> } &
  * { ["chunk.childrenByOrder[].children[]"]: SimplePrinter<ChunkId, "chunk"> } &
@@ -778,6 +801,7 @@ const CHUNK_PRINTERS = {
 };
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Printers<KnownStatsError, "error"> &
  * { ["error.filteredDetails"]?: SimplePrinter<number, "error"> } &
  * Exclamation<KnownStatsError, "error.separator", "error">} ErrorPrinters
@@ -822,6 +846,7 @@ const ERROR_PRINTERS = {
 };
 
 /**
+ * Defines the shared type used by this module.
  * @typedef {Printers<KnownStatsLoggingEntry, `loggingEntry(${LogTypeEnum}).loggingEntry`> &
  * { ["loggingEntry(clear).loggingEntry"]?: SimplePrinter<KnownStatsLoggingEntry, "logging"> } &
  * { ["loggingEntry.trace[]"]?: SimplePrinter<Exclude<KnownStatsLoggingEntry["trace"], undefined>[number], "logging"> } &
@@ -1178,6 +1203,7 @@ const SIMPLE_ITEMS_JOINER = {
 };
 
 /**
+ * Returns result.
  * @param {Item[]} items items
  * @returns {string} result
  */
@@ -1188,6 +1214,7 @@ const joinOneLine = (items) =>
 		.join(" ");
 
 /**
+ * Returns result.
  * @param {Item[]} items items
  * @returns {string} result
  */
@@ -1235,6 +1262,7 @@ const joinInBrackets = (items) => {
 };
 
 /**
+ * Returns result.
  * @param {string} str a string
  * @param {string} prefix prefix
  * @param {boolean=} noPrefixInFirstLine need prefix in the first line?
@@ -1248,6 +1276,7 @@ const indent = (str, prefix, noPrefixInFirstLine) => {
 };
 
 /**
+ * Join explicit new line.
  * @param {(false | Item)[]} items items
  * @param {string} indenter indenter
  * @returns {string} result
@@ -1274,12 +1303,14 @@ const joinExplicitNewLine = (items, indenter) => {
 };
 
 /**
+ * Returns joiner.
  * @param {boolean} error is an error
  * @returns {SimpleElementJoiner} joiner
  */
 const joinError =
 	(error) =>
 	/**
+	 * Handles the callback logic for this hook.
 	 * @param {Item[]} items items
 	 * @param {StatsPrinterContextWithExtra} ctx context
 	 * @returns {string} result
@@ -1447,11 +1478,13 @@ const AVAILABLE_COLORS = {
 };
 
 /**
+ * Defines the tail type used by this module.
  * @template T
  * @typedef {T extends [infer Head, ...infer Tail] ? Tail : undefined} Tail
  */
 
 /**
+ * Defines the tail parameters type used by this module.
  * @template {(...args: EXPECTED_ANY[]) => EXPECTED_ANY} T
  * @typedef {T extends (firstArg: EXPECTED_ANY, ...rest: infer R) => EXPECTED_ANY ? R : never} TailParameters
  */
@@ -1538,6 +1571,7 @@ const AVAILABLE_FORMATS = {
 			message = message.replace(
 				regExp,
 				/**
+				 * Handles the format callback for this hook.
 				 * @param {string} match match
 				 * @param {string} content content
 				 * @returns {string} result
@@ -1556,6 +1590,7 @@ const RESULT_MODIFIER = {
 };
 
 /**
+ * Creates an order from the provided array.
  * @param {string[]} array array
  * @param {string[]} preferredOrder preferred order
  * @returns {string[]} result
@@ -1585,7 +1620,7 @@ const PLUGIN_NAME = "DefaultStatsPrinterPlugin";
 
 class DefaultStatsPrinterPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -1626,6 +1661,7 @@ class DefaultStatsPrinterPlugin {
 									}\u001B[39m\u001B[22m`;
 							} else {
 								/**
+								 * Returns str string.
 								 * @param {string} str string
 								 * @returns {string} str string
 								 */

package/lib/stats/StatsFactory.js

@@ -22,6 +22,7 @@ const smartGrouping = require("../util/smartGrouping");
 /** @typedef {import("../util/comparators").Comparator<EXPECTED_ANY>} Comparator */
 /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
 /**
+ * Defines the group config type used by this module.
  * @template T, R
  * @typedef {import("../util/smartGrouping").GroupConfig<T, R>} GroupConfig
  */
@@ -42,6 +43,7 @@ const smartGrouping = require("../util/smartGrouping");
 /** @typedef {import("./DefaultStatsFactoryPlugin").StatsProfile} StatsProfile */
 
 /**
+ * Defines the known stats factory context type used by this module.
  * @typedef {object} KnownStatsFactoryContext
  * @property {string} type
  * @property {Compilation} compilation
@@ -59,12 +61,14 @@ const smartGrouping = require("../util/smartGrouping");
 // StatsLogging StatsLoggingEntry
 
 /**
+ * Defines the stats object type used by this module.
  * @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
  */
 
 /**
+ * Defines the created object type used by this module.
  * @template T
  * @template F
  * @typedef {T extends ChunkGroupInfoWithName[] ? Record<string, StatsObject<ChunkGroupInfoWithName, F>> : T extends (infer V)[] ? StatsObject<V, F>[] : StatsObject<T, F>} CreatedObject
@@ -76,6 +80,7 @@ const smartGrouping = require("../util/smartGrouping");
 /** @typedef {EXPECTED_ANY} Result */
 
 /**
+ * Defines the stats factory hooks type used by this module.
  * @typedef {object} StatsFactoryHooks
  * @property {HookMap<SyncBailHook<[ObjectForExtract, FactoryData, StatsFactoryContext], void>>} extract
  * @property {HookMap<SyncBailHook<[FactoryDataItem, StatsFactoryContext, number, number], boolean | void>>} filter
@@ -91,6 +96,7 @@ const smartGrouping = require("../util/smartGrouping");
  */
 
 /**
+ * Represents the stats factory runtime component.
  * @template T
  * @typedef {Map<string, T[]>} Caches
  */
@@ -133,6 +139,7 @@ class StatsFactory {
 	}
 
 	/**
+	 * Get all level hooks.
 	 * @template {StatsFactoryHooks[keyof StatsFactoryHooks]} HM
 	 * @template {HM extends HookMap<infer H> ? H : never} H
 	 * @param {HM} hookMap hook map
@@ -159,6 +166,7 @@ class StatsFactory {
 	}
 
 	/**
+	 * Returns hook.
 	 * @template {StatsFactoryHooks[keyof StatsFactoryHooks]} HM
 	 * @template {HM extends HookMap<infer H> ? H : never} H
 	 * @template {H extends import("tapable").Hook<EXPECTED_ANY, infer R> ? R : never} R
@@ -177,6 +185,7 @@ class StatsFactory {
 	}
 
 	/**
+	 * For each level waterfall.
 	 * @template {StatsFactoryHooks[keyof StatsFactoryHooks]} HM
 	 * @template {HM extends HookMap<infer H> ? H : never} H
 	 * @param {HM} hookMap hook map
@@ -195,6 +204,7 @@ class StatsFactory {
 	}
 
 	/**
+	 * For each level filter.
 	 * @template {StatsFactoryHooks[keyof StatsFactoryHooks]} T
 	 * @template {T extends HookMap<infer H> ? H : never} H
 	 * @template {H extends import("tapable").Hook<EXPECTED_ANY, infer R> ? R : never} R
@@ -225,6 +235,7 @@ class StatsFactory {
 	}
 
 	/**
+	 * Returns created object.
 	 * @template FactoryData
 	 * @template FallbackCreatedObject
 	 * @param {string} type type
@@ -248,6 +259,7 @@ class StatsFactory {
 	}
 
 	/**
+	 * Returns created object.
 	 * @private
 	 * @template FactoryData
 	 * @template FallbackCreatedObject

package/lib/stats/StatsPrinter.js

@@ -21,12 +21,14 @@ const { HookMap, SyncBailHook, SyncWaterfallHook } = require("tapable");
 /** @typedef {import("./DefaultStatsFactoryPlugin").StatsProfile} StatsProfile */
 
 /**
+ * Defines the printed element type used by this module.
  * @typedef {object} PrintedElement
  * @property {string} element
  * @property {string | undefined} content
  */
 
 /**
+ * Defines the known stats printer context type used by this module.
  * @typedef {object} KnownStatsPrinterContext
  * @property {string=} type
  * @property {StatsCompilation=} compilation
@@ -47,6 +49,7 @@ const { HookMap, SyncBailHook, SyncWaterfallHook } = require("tapable");
 /** @typedef {(value: string | number) => string} ColorFunction */
 
 /**
+ * Defines the known stats printer color functions type used by this module.
  * @typedef {object} KnownStatsPrinterColorFunctions
  * @property {ColorFunction=} bold
  * @property {ColorFunction=} yellow
@@ -57,6 +60,7 @@ const { HookMap, SyncBailHook, SyncWaterfallHook } = require("tapable");
  */
 
 /**
+ * Defines the known stats printer formatters type used by this module.
  * @typedef {object} KnownStatsPrinterFormatters
  * @property {(file: string, oversize?: boolean) => string=} formatFilename
  * @property {(id: string | number) => string=} formatModuleId
@@ -74,6 +78,7 @@ const { HookMap, SyncBailHook, SyncWaterfallHook } = require("tapable");
 /** @typedef {EXPECTED_ANY} PrintObject */
 
 /**
+ * Represents the stats printer runtime component.
  * @typedef {object} StatsPrintHooks
  * @property {HookMap<SyncBailHook<[string[], StatsPrinterContext], void>>} sortElements
  * @property {HookMap<SyncBailHook<[PrintedElement[], StatsPrinterContext], string | undefined | void>>} printElements
@@ -176,6 +181,7 @@ class StatsPrinter {
 	}
 
 	/**
+	 * Returns printed result.
 	 * @param {string} type The type
 	 * @param {PrintObject} object Object to print
 	 * @param {StatsPrinterContext=} baseContext The base context
@@ -195,6 +201,7 @@ class StatsPrinter {
 	}
 
 	/**
+	 * Returns printed result.
 	 * @private
 	 * @param {string} type type
 	 * @param {PrintObject} object object

package/lib/url/URLParserPlugin.js

@@ -28,12 +28,14 @@ const InnerGraph = require("../optimize/InnerGraph");
 const PLUGIN_NAME = "URLParserPlugin";
 
 /**
+ * Returns file url.
  * @param {NormalModule} module module
  * @returns {URL} file url
  */
 const getUrl = (module) => pathToFileURL(module.resource);
 
 /**
+ * Checks whether this object is meta url.
  * @param {JavascriptParser} parser parser parser
  * @param {MemberExpression} arg arg
  * @returns {boolean} true when it is `meta.url`, otherwise false
@@ -58,6 +60,7 @@ const isMetaUrl = (parser, arg) => {
 const getEvaluatedExprCache = new WeakMap();
 
 /**
+ * Gets evaluated expr.
  * @param {NewExpressionNode} expr expression
  * @param {JavascriptParser} parser parser parser
  * @returns {BasicEvaluatedExpression | undefined} basic evaluated expression
@@ -67,6 +70,7 @@ const getEvaluatedExpr = (expr, parser) => {
 	if (result !== undefined) return result;
 
 	/**
+	 * Returns basic evaluated expression.
 	 * @returns {BasicEvaluatedExpression | undefined} basic evaluated expression
 	 */
 	const evaluate = () => {
@@ -90,6 +94,7 @@ const getEvaluatedExpr = (expr, parser) => {
 
 class URLParserPlugin {
 	/**
+	 * Creates an instance of URLParserPlugin.
 	 * @param {JavascriptParserOptions} options options
 	 */
 	constructor(options) {
@@ -98,6 +103,7 @@ class URLParserPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {JavascriptParser} parser the parser
 	 * @returns {void}
 	 */

package/lib/util/AppendOnlyStackedSet.js

@@ -6,10 +6,14 @@
 "use strict";
 
 /**
+ * Tracks values across a stack of nested sets where child scopes can add new
+ * values without mutating the sets created by their parents.
  * @template T
  */
 class AppendOnlyStackedSet {
 	/**
+	 * Seeds the stacked set with an optional chain of previously created scope
+	 * layers.
 	 * @param {Set<T>[]} sets an optional array of sets
 	 */
 	constructor(sets = []) {
@@ -20,6 +24,8 @@ class AppendOnlyStackedSet {
 	}
 
 	/**
+	 * Adds a value to the current scope layer, creating that layer lazily when
+	 * the first write occurs.
 	 * @param {T} el element
 	 */
 	add(el) {
@@ -31,6 +37,8 @@ class AppendOnlyStackedSet {
 	}
 
 	/**
+	 * Checks whether a value is present in any scope layer currently visible to
+	 * this stacked set.
 	 * @param {T} el element
 	 * @returns {boolean} result
 	 */
@@ -41,6 +49,9 @@ class AppendOnlyStackedSet {
 		return false;
 	}
 
+	/**
+	 * Removes every scope layer and any values accumulated in them.
+	 */
 	clear() {
 		this._sets = [];
 		if (this._current) {
@@ -49,6 +60,8 @@ class AppendOnlyStackedSet {
 	}
 
 	/**
+	 * Creates a child stacked set that shares the existing scope history while
+	 * allowing subsequent additions to be recorded in its own new layer.
 	 * @returns {AppendOnlyStackedSet<T>} child
 	 */
 	createChild() {
@@ -56,6 +69,8 @@ class AppendOnlyStackedSet {
 	}
 
 	/**
+	 * Iterates over the stacked sets from newest to oldest so consumers can
+	 * inspect recently added values first.
 	 * @returns {Iterator<T>} iterable iterator
 	 */
 	[Symbol.iterator]() {

package/lib/util/ArrayHelpers.js

@@ -34,6 +34,7 @@ module.exports.groupBy = (
 ) =>
 	arr.reduce(
 		/**
+		 * Handles the callback logic for this hook.
 		 * @param {[T[], T[]]} groups An accumulator storing already partitioned values returned from previous call.
 		 * @param {T} value The value of the current element
 		 * @returns {[T[], T[]]} returns an array of partitioned groups accumulator resulting from calling a predicate on the current value.

package/lib/util/ArrayQueue.js

@@ -6,10 +6,13 @@
 "use strict";
 
 /**
+ * FIFO queue backed by arrays with a reversed dequeue buffer to avoid the cost
+ * of repeated `Array#shift` operations.
  * @template T
  */
 class ArrayQueue {
 	/**
+	 * Seeds the queue with an optional iterable of items in dequeue order.
 	 * @param {Iterable<T>=} items The initial elements.
 	 */
 	constructor(items) {
@@ -26,7 +29,7 @@ class ArrayQueue {
 	}
 
 	/**
-	 * Returns the number of elements in this queue.
+	 * Returns the current number of items waiting in either internal buffer.
 	 * @returns {number} The number of elements in this queue.
 	 */
 	get length() {
@@ -34,7 +37,7 @@ class ArrayQueue {
 	}
 
 	/**
-	 * Empties the queue.
+	 * Removes all pending items from both internal buffers.
 	 */
 	clear() {
 		this._list.length = 0;
@@ -42,7 +45,7 @@ class ArrayQueue {
 	}
 
 	/**
-	 * Appends the specified element to this queue.
+	 * Appends an item to the tail of the queue.
 	 * @param {T} item The element to add.
 	 * @returns {void}
 	 */
@@ -51,7 +54,8 @@ class ArrayQueue {
 	}
 
 	/**
-	 * Retrieves and removes the head of this queue.
+	 * Removes and returns the next item in FIFO order, switching to a reversed
+	 * buffer when that is cheaper than shifting from the front of the array.
 	 * @returns {T | undefined} The head of the queue of `undefined` if this queue is empty.
 	 */
 	dequeue() {
@@ -68,7 +72,8 @@ class ArrayQueue {
 	}
 
 	/**
-	 * Finds and removes an item
+	 * Removes the first matching item from whichever internal buffer currently
+	 * contains it.
 	 * @param {T} item the item
 	 * @returns {void}
 	 */