webpack 5.106.1 → 5.106.2

package/lib/stats/DefaultStatsFactoryPlugin.js

@@ -54,17 +54,20 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 /** @typedef {import("../ExportsInfo").ExportInfoName} ExportInfoName */
 
 /**
+ * Defines the shared type used by this module.
  * @template T
  * @typedef {import("../util/comparators").Comparator<T>} Comparator<T>
  */
 
 /**
+ * Defines the group config type used by this module.
  * @template I, G
  * @typedef {import("../util/smartGrouping").GroupConfig<I, G>} GroupConfig
  */
 
 /** @typedef {KnownStatsCompilation & Record<string, EXPECTED_ANY>} StatsCompilation */
 /**
+ * Defines the known stats compilation type used by this module.
  * @typedef {object} KnownStatsCompilation
  * @property {EXPECTED_ANY=} env
  * @property {string=} name
@@ -95,6 +98,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsLogging & Record<string, EXPECTED_ANY>} StatsLogging */
 /**
+ * Defines the known stats logging type used by this module.
  * @typedef {object} KnownStatsLogging
  * @property {StatsLoggingEntry[]} entries
  * @property {number} filteredEntries
@@ -103,6 +107,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsLoggingEntry & Record<string, EXPECTED_ANY>} StatsLoggingEntry */
 /**
+ * Defines the known stats logging entry type used by this module.
  * @typedef {object} KnownStatsLoggingEntry
  * @property {string} type
  * @property {string=} message
@@ -115,6 +120,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 /** @typedef {KnownStatsAsset & Record<string, EXPECTED_ANY>} StatsAsset */
 /** @typedef {string[]} ChunkIdHints */
 /**
+ * Defines the known stats asset type used by this module.
  * @typedef {object} KnownStatsAsset
  * @property {string} type
  * @property {string} name
@@ -136,6 +142,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsChunkGroup & Record<string, EXPECTED_ANY>} StatsChunkGroup */
 /**
+ * Defines the known stats chunk group type used by this module.
  * @typedef {object} KnownStatsChunkGroup
  * @property {ChunkName=} name
  * @property {ChunkId[]=} chunks
@@ -153,6 +160,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 /** @typedef {Module[]} ModuleIssuerPath */
 /** @typedef {KnownStatsModule & Record<string, EXPECTED_ANY>} StatsModule */
 /**
+ * Defines the known stats module type used by this module.
  * @typedef {object} KnownStatsModule
  * @property {string=} type
  * @property {string=} moduleType
@@ -197,6 +205,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsProfile & Record<string, EXPECTED_ANY>} StatsProfile */
 /**
+ * Defines the known stats profile type used by this module.
  * @typedef {object} KnownStatsProfile
  * @property {number} total
  * @property {number} resolving
@@ -212,6 +221,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsModuleIssuer & Record<string, EXPECTED_ANY>} StatsModuleIssuer */
 /**
+ * Defines the known stats module issuer type used by this module.
  * @typedef {object} KnownStatsModuleIssuer
  * @property {string} identifier
  * @property {string} name
@@ -221,6 +231,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsModuleReason & Record<string, EXPECTED_ANY>} StatsModuleReason */
 /**
+ * Defines the known stats module reason type used by this module.
  * @typedef {object} KnownStatsModuleReason
  * @property {string | null} moduleIdentifier
  * @property {string | null} module
@@ -238,6 +249,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsChunk & Record<string, EXPECTED_ANY>} StatsChunk */
 /**
+ * Defines the known stats chunk type used by this module.
  * @typedef {object} KnownStatsChunk
  * @property {boolean} rendered
  * @property {boolean} initial
@@ -264,6 +276,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsChunkOrigin & Record<string, EXPECTED_ANY>} StatsChunkOrigin */
 /**
+ * Defines the known stats chunk origin type used by this module.
  * @typedef {object} KnownStatsChunkOrigin
  * @property {string} module
  * @property {string} moduleIdentifier
@@ -275,6 +288,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsModuleTraceItem & Record<string, EXPECTED_ANY>} StatsModuleTraceItem */
 /**
+ * Defines the known stats module trace item type used by this module.
  * @typedef {object} KnownStatsModuleTraceItem
  * @property {string=} originIdentifier
  * @property {string=} originName
@@ -287,12 +301,14 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 
 /** @typedef {KnownStatsModuleTraceDependency & Record<string, EXPECTED_ANY>} StatsModuleTraceDependency */
 /**
+ * Defines the known stats module trace dependency type used by this module.
  * @typedef {object} KnownStatsModuleTraceDependency
  * @property {string=} loc
  */
 
 /** @typedef {KnownStatsError & Record<string, EXPECTED_ANY>} StatsError */
 /**
+ * Defines the known stats error type used by this module.
  * @typedef {object} KnownStatsError
  * @property {string} message
  * @property {string=} chunkName
@@ -315,6 +331,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 /** @typedef {Asset & { type: string, related: PreprocessedAsset[] | undefined }} PreprocessedAsset */
 
 /**
+ * Defines the extractors by option type used by this module.
  * @template T
  * @template O
  * @typedef {Record<string, (object: O, data: T, context: StatsFactoryContext, options: NormalizedStatsOptions, factory: StatsFactory) => void>} ExtractorsByOption
@@ -324,6 +341,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
 /** @typedef {{ origin: Module, module: Module }} ModuleTrace */
 
 /**
+ * Defines the simple extractors type used by this module.
  * @typedef {object} SimpleExtractors
  * @property {ExtractorsByOption<Compilation, StatsCompilation>} compilation
  * @property {ExtractorsByOption<PreprocessedAsset, StatsAsset>} asset
@@ -344,6 +362,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
  */
 
 /**
+ * Returns array of values.
  * @template T
  * @template I
  * @param {Iterable<T>} items items to select from
@@ -362,6 +381,7 @@ const uniqueArray = (items, selector) => {
 };
 
 /**
+ * Unique ordered array.
  * @template T
  * @template I
  * @param {Iterable<T>} items items to select from
@@ -373,12 +393,14 @@ const uniqueOrderedArray = (items, selector, comparator) =>
 	uniqueArray(items, selector).sort(comparator);
 
 /**
+ * Defines the shared type used by this module.
  * @template T
  * @template R
  * @typedef {{ [P in keyof T]: R }} MappedValues<T, R>
  */
 
 /**
+ * Returns mapped object.
  * @template {object} T
  * @template {object} R
  * @param {T} obj object to be mapped
@@ -395,6 +417,7 @@ const mapObject = (obj, fn) => {
 };
 
 /**
+ * Count with children.
  * @template T
  * @param {Compilation} compilation the compilation
  * @param {(compilation: Compilation, name: string) => T[]} getItems get items
@@ -998,6 +1021,7 @@ const SIMPLE_EXTRACTORS = {
 					.create(`${type}${childType}.warnings`, cachedGetWarnings(c), context)
 					.filter(
 						/**
+						 * Handles the warnings count callback for this hook.
 						 * @param {StatsError} warning warning
 						 * @returns {boolean} result
 						 */
@@ -1122,6 +1146,7 @@ const SIMPLE_EXTRACTORS = {
 				chunkGroupChildren &&
 				chunkGroup.getChildrenByOrders(moduleGraph, chunkGraph);
 			/**
+			 * Returns } Asset object.
 			 * @param {string} name Name
 			 * @returns {{ name: string, size: number }} Asset object
 			 */
@@ -1743,6 +1768,7 @@ const SORTERS = {
 					concatComparators(
 						compareSelect(
 							/**
+							 * Handles the  callback for this hook.
 							 * @param {Dependency} x dependency
 							 * @returns {DependencyLocation} location
 							 */
@@ -1771,11 +1797,13 @@ const SORTERS = {
 };
 
 /**
+ * Defines the children type used by this module.
  * @template T
  * @typedef {T & { children?: Children<T>[] | undefined, filteredChildren?: number }} Children
  */
 
 /**
+ * Returns item size.
  * @template T
  * @param {Children<T>} item item
  * @returns {number} item size
@@ -1791,6 +1819,7 @@ const getItemSize = (item) =>
 			: 1 + getTotalSize(item.children);
 
 /**
+ * Returns total size.
  * @template T
  * @param {Children<T>[]} children children
  * @returns {number} total size
@@ -1804,6 +1833,7 @@ const getTotalSize = (children) => {
 };
 
 /**
+ * Returns total items.
  * @template T
  * @param {Children<T>[]} children children
  * @returns {number} total items
@@ -1822,6 +1852,7 @@ const getTotalItems = (children) => {
 };
 
 /**
+ * Returns collapsed children.
  * @template T
  * @param {Children<T>[]} children children
  * @returns {Children<T>[]} collapsed children
@@ -1847,6 +1878,7 @@ const collapse = (children) => {
 };
 
 /**
+ * Returns result.
  * @template T
  * @param {Children<T>[]} itemsAndGroups item and groups
  * @param {number} max max
@@ -1976,6 +2008,7 @@ const spaceLimited = (
 };
 
 /**
+ * Errors space limit.
  * @param {StatsError[]} errors errors
  * @param {number} max max
  * @returns {[StatsError[], number]} error space limit
@@ -2039,6 +2072,7 @@ const errorsSpaceLimit = (errors, max) => {
 };
 
 /**
+ * Returns } asset size.
  * @template {{ size: number }} T
  * @param {T[]} children children
  * @param {T[]} assets assets
@@ -2055,6 +2089,7 @@ const assetGroup = (children, assets) => {
 /** @typedef {{ size: number, sizes: Record<string, number> }} ModuleGroupBySizeResult */
 
 /**
+ * Returns size and sizes.
  * @template {ModuleGroupBySizeResult} T
  * @param {Children<T>[]} children children
  * @param {KnownStatsModule[]} modules modules
@@ -2077,6 +2112,7 @@ const moduleGroup = (children, modules) => {
 };
 
 /**
+ * Returns } reason group.
  * @template {{ active: boolean }} T
  * @param {Children<T>[]} children children
  * @param {KnownStatsModuleReason[]} reasons reasons
@@ -2098,6 +2134,7 @@ const GROUP_PATH_REGEXP = /(.+)[/\\][^/\\]+?(?:\?|(?: \+ \d+ modules?)?$)/;
 /** @typedef {{ type: string }} BaseGroup */
 
 /**
+ * Defines the base group with children type used by this module.
  * @template T
  * @typedef {BaseGroup & { children: T[], size: number }} BaseGroupWithChildren
  */
@@ -2105,6 +2142,7 @@ const GROUP_PATH_REGEXP = /(.+)[/\\][^/\\]+?(?:\?|(?: \+ \d+ modules?)?$)/;
 /** @typedef {(name: string, asset: StatsAsset) => boolean} AssetFilterItemFn */
 
 /**
+ * Describes the assets groupers shape.
  * @typedef {{
  * _: (groupConfigs: GroupConfig<KnownStatsAsset, BaseGroup & { filteredChildren: number, size: number } | BaseGroupWithChildren<KnownStatsAsset>>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void,
  * groupAssetsByInfo: (groupConfigs: GroupConfig<KnownStatsAsset, BaseGroupWithChildren<KnownStatsAsset>>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void,
@@ -2117,6 +2155,7 @@ const GROUP_PATH_REGEXP = /(.+)[/\\][^/\\]+?(?:\?|(?: \+ \d+ modules?)?$)/;
 const ASSETS_GROUPERS = {
 	_: (groupConfigs, context, options) => {
 		/**
+		 * Processes the provided name.
 		 * @param {keyof KnownStatsAsset} name name
 		 * @param {boolean=} exclude need exclude?
 		 */
@@ -2196,6 +2235,7 @@ const ASSETS_GROUPERS = {
 	},
 	groupAssetsByInfo: (groupConfigs, _context, _options) => {
 		/**
+		 * Group by asset info flag.
 		 * @param {string} name name
 		 */
 		const groupByAssetInfoFlag = (name) => {
@@ -2218,6 +2258,7 @@ const ASSETS_GROUPERS = {
 	},
 	groupAssetsByChunk: (groupConfigs, _context, _options) => {
 		/**
+		 * Processes the provided name.
 		 * @param {keyof KnownStatsAsset} name name
 		 */
 		const groupByNames = (name) => {
@@ -2257,6 +2298,7 @@ const ASSETS_GROUPERS = {
 };
 
 /**
+ * Describes the modules groupers shape.
  * @typedef {{
  * _: (groupConfigs: GroupConfig<KnownStatsModule, BaseGroup & { filteredChildren?: number, children?: KnownStatsModule[], size: number, sizes: Record<string, number> }>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void,
  * excludeModules: (groupConfigs: GroupConfig<KnownStatsModule, BaseGroup & { filteredChildren: number, size: number, sizes: Record<string, number> }>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void,
@@ -2271,6 +2313,7 @@ const ASSETS_GROUPERS = {
 const MODULES_GROUPERS = (type) => ({
 	_: (groupConfigs, context, options) => {
 		/**
+		 * Processes the provided name.
 		 * @param {keyof KnownStatsModule} name name
 		 * @param {string} type type
 		 * @param {boolean=} exclude need exclude?
@@ -2452,6 +2495,7 @@ const MODULES_GROUPERS = (type) => ({
 });
 
 /**
+ * Defines the module reasons groupers type used by this module.
  * @typedef {{ groupReasonsByOrigin: (groupConfigs: GroupConfig<KnownStatsModuleReason, BaseGroup & { module: string, children: KnownStatsModuleReason[], active: boolean }>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void }} ModuleReasonsGroupers
  */
 
@@ -2493,6 +2537,7 @@ const RESULT_GROUPERS = {
 
 // remove a prefixed "!" that can be specified to reverse sort order
 /**
+ * Normalizes field key.
  * @param {string} field a field name
  * @returns {field} normalized field
  */
@@ -2505,6 +2550,7 @@ const normalizeFieldKey = (field) => {
 
 // if a field is prefixed by a "!" reverse sort order
 /**
+ * Sorts order regular.
  * @param {string} field a field name
  * @returns {boolean} result
  */
@@ -2516,6 +2562,7 @@ const sortOrderRegular = (field) => {
 };
 
 /**
+ * Returns comparators.
  * @template T
  * @param {string | false} field field name
  * @returns {(a: T, b: T) => 0 | 1 | -1} comparators
@@ -2523,6 +2570,7 @@ const sortOrderRegular = (field) => {
 const sortByField = (field) => {
 	if (!field) {
 		/**
+		 * Returns zero.
 		 * @param {T} a first
 		 * @param {T} b second
 		 * @returns {-1 | 0 | 1} zero
@@ -2547,6 +2595,7 @@ const sortByField = (field) => {
 };
 
 /**
+ * Describes the asset sorters shape.
  * @typedef {{
  * assetsSort: (comparators: Comparator<Asset>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void,
  * _: (comparators: Comparator<Asset>[], context: StatsFactoryContext, options: NormalizedStatsOptions) => void,
@@ -2599,11 +2648,13 @@ const RESULT_SORTERS = {
 };
 
 /**
+ * Defines the extract function type used by this module.
  * @template T
  * @typedef {T extends Record<string, Record<string, infer F>> ? F : never} ExtractFunction
  */
 
 /**
+ * Processes the provided config.
  * @template {Record<string, Record<string, EXPECTED_ANY>>} T
  * @param {T} config the config see above
  * @param {NormalizedStatsOptions} options stats options
@@ -2658,11 +2709,13 @@ const ITEM_NAMES = {
 };
 
 /**
+ * Defines the named object type used by this module.
  * @template T
  * @typedef {{ name: T }} NamedObject
  */
 
 /**
+ * Merges the provided values into a single result.
  * @template {{ name: string }} T
  * @param {T[]} items items to be merged
  * @returns {NamedObject<T>} an object
@@ -2688,7 +2741,7 @@ const PLUGIN_NAME = "DefaultStatsFactoryPlugin";
 
 class DefaultStatsFactoryPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -2697,6 +2750,7 @@ class DefaultStatsFactoryPlugin {
 			compilation.hooks.statsFactory.tap(
 				PLUGIN_NAME,
 				/**
+				 * Handles the callback logic for this hook.
 				 * @param {StatsFactory} stats stats factory
 				 * @param {NormalizedStatsOptions} options stats options
 				 */
@@ -2758,6 +2812,7 @@ class DefaultStatsFactoryPlugin {
 								.tap(
 									PLUGIN_NAME,
 									/**
+									 * Handles the callback logic for this hook.
 									 * @param {Compilation} comp compilation
 									 * @param {StatsFactoryContext} options options
 									 * @returns {StatsFactory | undefined} stats factory

package/lib/stats/DefaultStatsPresetPlugin.js

@@ -17,6 +17,7 @@ const RequestShortener = require("../RequestShortener");
 /** @typedef {import("./DefaultStatsFactoryPlugin").StatsError} StatsError */
 
 /**
+ * Processes the provided normalized stats option.
  * @param {Partial<NormalizedStatsOptions>} options options
  * @param {StatsOptions} defaults default options
  */
@@ -144,16 +145,19 @@ const NAMED_PRESETS = {
 };
 
 /**
+ * Returns true when enabled, otherwise false.
  * @param {Partial<NormalizedStatsOptions>} all stats options
  * @returns {boolean} true when enabled, otherwise false
  */
 const NORMAL_ON = ({ all }) => all !== false;
 /**
+ * Returns true when enabled, otherwise false.
  * @param {Partial<NormalizedStatsOptions>} all stats options
  * @returns {boolean} true when enabled, otherwise false
  */
 const NORMAL_OFF = ({ all }) => all === true;
 /**
+ * Returns true when enabled, otherwise false.
  * @param {Partial<NormalizedStatsOptions>} all stats options
  * @param {CreateStatsOptionsContext} forToString stats options context
  * @returns {boolean} true when enabled, otherwise false
@@ -161,6 +165,7 @@ const NORMAL_OFF = ({ all }) => all === true;
 const ON_FOR_TO_STRING = ({ all }, { forToString }) =>
 	forToString ? all !== false : all === true;
 /**
+ * Returns true when enabled, otherwise false.
  * @param {Partial<NormalizedStatsOptions>} all stats options
  * @param {CreateStatsOptionsContext} forToString stats options context
  * @returns {boolean} true when enabled, otherwise false
@@ -168,6 +173,7 @@ const ON_FOR_TO_STRING = ({ all }, { forToString }) =>
 const OFF_FOR_TO_STRING = ({ all }, { forToString }) =>
 	forToString ? all === true : all !== false;
 /**
+ * Auto for to string.
  * @param {Partial<NormalizedStatsOptions>} all stats options
  * @param {CreateStatsOptionsContext} forToString stats options context
  * @returns {boolean | "auto"} true when enabled, otherwise false
@@ -285,11 +291,13 @@ const DEFAULTS = {
 };
 
 /**
+ * Defines the normalize function type used by this module.
  * @template T
  * @typedef {(value: T, ...args: EXPECTED_ANY[]) => boolean} NormalizeFunction
  */
 
 /**
+ * Returns normalize fn.
  * @template {string} T
  * @param {string | ({ test: (value: T) => boolean }) | NormalizeFunction<T> | boolean} item item to normalize
  * @returns {NormalizeFunction<T>} normalize fn
@@ -315,6 +323,7 @@ const normalizeFilter = (item) => {
 /** @typedef {{ [Key in NormalizerKeys]?: (value: StatsOptions[Key]) => KnownNormalizedStatsOptions[Key] }} Normalizers */
 
 /**
+ * Defines the warning filter fn callback.
  * @callback WarningFilterFn
  * @param {StatsError} warning warning
  * @param {string} warningString warning string
@@ -343,6 +352,7 @@ const NORMALIZER = {
 		}
 		return value.map(
 			/**
+			 * Handles the warnings filter callback for this hook.
 			 * @param {StatsOptions["warningsFilter"]} filter a warning filter
 			 * @returns {WarningFilterFn} result
 			 */
@@ -380,7 +390,7 @@ const PLUGIN_NAME = "DefaultStatsPresetPlugin";
 
 class DefaultStatsPresetPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */