webpack 5.106.0 → 5.106.2

package/lib/optimize/SplitChunksPlugin.js

@@ -38,6 +38,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
 /** @typedef {import("../util/deterministicGrouping").Sizes} Sizes */
 
 /**
+ * Defines the chunk filter fn callback.
  * @callback ChunkFilterFn
  * @param {Chunk} chunk
  * @returns {boolean | undefined}
@@ -49,6 +50,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
 /** @typedef {number} CountOfRequest */
 
 /**
+ * Defines the combine size function callback.
  * @callback CombineSizeFunction
  * @param {Size} a
  * @param {Size} b
@@ -60,6 +62,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
 /** @typedef {Record<SourceType, Size>} SplitChunksSizes */
 
 /**
+ * Defines the cache group source type used by this module.
  * @typedef {object} CacheGroupSource
  * @property {string} key
  * @property {Priority=} priority
@@ -83,6 +86,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
  */
 
 /**
+ * Defines the cache group type used by this module.
  * @typedef {object} CacheGroup
  * @property {string} key
  * @property {Priority} priority
@@ -109,6 +113,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
  */
 
 /**
+ * Defines the fallback cache group type used by this module.
  * @typedef {object} FallbackCacheGroup
  * @property {ChunkFilterFn} chunksFilter
  * @property {SplitChunksSizes} minSize
@@ -118,6 +123,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
  */
 
 /**
+ * Defines the cache groups context type used by this module.
  * @typedef {object} CacheGroupsContext
  * @property {ModuleGraph} moduleGraph
  * @property {ChunkGraph} chunkGraph
@@ -126,6 +132,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
 /** @typedef {(module: Module) => OptimizationSplitChunksCacheGroup | OptimizationSplitChunksCacheGroup[] | void} RawGetCacheGroups */
 
 /**
+ * Defines the get cache groups callback.
  * @callback GetCacheGroups
  * @param {Module} module
  * @param {CacheGroupsContext} context
@@ -133,6 +140,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
  */
 
 /**
+ * Defines the get name fn callback.
  * @callback GetNameFn
  * @param {Module} module
  * @param {Chunk[]} chunks
@@ -141,6 +149,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
  */
 
 /**
+ * Defines the split chunks options type used by this module.
  * @typedef {object} SplitChunksOptions
  * @property {ChunkFilterFn} chunksFilter
  * @property {DefaultSizeTypes} defaultSizeTypes
@@ -165,6 +174,7 @@ const MinMaxSizeWarning = require("./MinMaxSizeWarning");
 /** @typedef {Set<Chunk>} ChunkSet  */
 
 /**
+ * Defines the chunks info item type used by this module.
  * @typedef {object} ChunksInfoItem
  * @property {SortableSet<Module>} modules
  * @property {CacheGroup} cacheGroup
@@ -187,6 +197,7 @@ const deterministicGroupingForModules =
 const getKeyCache = new WeakMap();
 
 /**
+ * Returns hashed filename.
  * @param {string} name a filename to hash
  * @param {OutputOptions} outputOptions hash function used
  * @returns {string} hashed filename
@@ -203,6 +214,7 @@ const hashFilename = (name, outputOptions) => {
 };
 
 /**
+ * Returns the number of requests.
  * @param {Chunk} chunk the chunk
  * @returns {CountOfRequest} the number of requests
  */
@@ -215,6 +227,7 @@ const getRequests = (chunk) => {
 };
 
 /**
+ * Returns result.
  * @template {object} T
  * @template {object} R
  * @param {T} obj obj an object
@@ -235,6 +248,7 @@ const mapObject = (obj, fn) => {
 };
 
 /**
+ * Checks whether this object is overlap.
  * @template T
  * @param {Set<T>} a set
  * @param {Set<T>} b other set
@@ -250,6 +264,7 @@ const isOverlap = (a, b) => {
 const compareModuleIterables = compareIterables(compareModulesByIdentifier);
 
 /**
+ * Compares the provided values and returns their ordering.
  * @param {ChunksInfoItem} a item
  * @param {ChunksInfoItem} b item
  * @returns {number} compare result
@@ -281,22 +296,26 @@ const compareEntries = (a, b) => {
 };
 
 /**
+ * Initial chunk filter.
  * @param {Chunk} chunk the chunk
  * @returns {boolean} true, if the chunk is an entry chunk
  */
 const INITIAL_CHUNK_FILTER = (chunk) => chunk.canBeInitial();
 /**
+ * Async chunk filter.
  * @param {Chunk} chunk the chunk
  * @returns {boolean} true, if the chunk is an async chunk
  */
 const ASYNC_CHUNK_FILTER = (chunk) => !chunk.canBeInitial();
 /**
+ * Returns always true.
  * @param {Chunk} _chunk the chunk
  * @returns {boolean} always true
  */
 const ALL_CHUNK_FILTER = (_chunk) => true;
 
 /**
+ * Returns normalized representation.
  * @param {OptimizationSplitChunksSizes | undefined} value the sizes
  * @param {DefaultSizeTypes} defaultSizeTypes the default size types
  * @returns {SplitChunksSizes} normalized representation
@@ -314,6 +333,7 @@ const normalizeSizes = (value, defaultSizeTypes) => {
 };
 
 /**
+ * Merges the provided values into a single result.
  * @param {...(SplitChunksSizes | undefined)} sizes the sizes
  * @returns {SplitChunksSizes} the merged sizes
  */
@@ -327,6 +347,7 @@ const mergeSizes = (...sizes) => {
 };
 
 /**
+ * Checks whether this object contains the size.
  * @param {SplitChunksSizes} sizes the sizes
  * @returns {boolean} true, if there are sizes > 0
  */
@@ -338,6 +359,7 @@ const hasNonZeroSizes = (sizes) => {
 };
 
 /**
+ * Returns the combine sizes.
  * @param {SplitChunksSizes} a first sizes
  * @param {SplitChunksSizes} b second sizes
  * @param {CombineSizeFunction} combine a function to combine sizes
@@ -360,6 +382,7 @@ const combineSizes = (a, b, combine) => {
 };
 
 /**
+ * Checks true if there are sizes and all existing sizes are at least minSize.
  * @param {SplitChunksSizes} sizes the sizes
  * @param {SplitChunksSizes} minSize the min sizes
  * @returns {boolean} true if there are sizes and all existing sizes are at least `minSize`
@@ -374,6 +397,7 @@ const checkMinSize = (sizes, minSize) => {
 };
 
 /**
+ * Checks min size reduction.
  * @param {SplitChunksSizes} sizes the sizes
  * @param {SplitChunksSizes} minSizeReduction the min sizes
  * @param {CountOfChunk} chunkCount number of chunks
@@ -391,6 +415,7 @@ const checkMinSizeReduction = (sizes, minSizeReduction, chunkCount) => {
 };
 
 /**
+ * Gets violating min sizes.
  * @param {SplitChunksSizes} sizes the sizes
  * @param {SplitChunksSizes} minSize the min sizes
  * @returns {undefined | SourceTypes} list of size types that are below min size
@@ -410,6 +435,7 @@ const getViolatingMinSizes = (sizes, minSize) => {
 };
 
 /**
+ * Returns the total size.
  * @param {SplitChunksSizes} sizes the sizes
  * @returns {Size} the total size
  */
@@ -422,6 +448,7 @@ const totalSize = (sizes) => {
 };
 
 /**
+ * Returns a function to get the name of the chunk.
  * @param {OptimizationSplitChunksCacheGroup["name"]} name the chunk name
  * @returns {GetNameFn | undefined} a function to get the name of the chunk
  */
@@ -435,6 +462,7 @@ const normalizeName = (name) => {
 };
 
 /**
+ * Normalizes chunks filter.
  * @param {OptimizationSplitChunksCacheGroup["chunks"]} chunks the chunk filter option
  * @returns {ChunkFilterFn | undefined} the chunk filter function
  */
@@ -457,6 +485,7 @@ const normalizeChunksFilter = (chunks) => {
 };
 
 /**
+ * Normalizes cache groups.
  * @param {undefined | GetCacheGroups | Record<string, false | string | RegExp | RawGetCacheGroups | OptimizationSplitChunksCacheGroup>} cacheGroups the cache group options
  * @param {DefaultSizeTypes} defaultSizeTypes the default size types
  * @returns {GetCacheGroups} a function to get the cache groups
@@ -517,6 +546,7 @@ const normalizeCacheGroups = (cacheGroups, defaultSizeTypes) => {
 			}
 		}
 		/**
+		 * Returns the matching cache groups.
 		 * @param {Module} module the current module
 		 * @param {CacheGroupsContext} context the current context
 		 * @returns {CacheGroupSource[]} the matching cache groups
@@ -537,6 +567,7 @@ const normalizeCacheGroups = (cacheGroups, defaultSizeTypes) => {
 /** @typedef {(module: Module, context: CacheGroupsContext) => boolean} CheckTestFn */
 
 /**
+ * Checks true, if the module should be selected.
  * @param {OptimizationSplitChunksCacheGroup["test"]} test test option
  * @param {Module} module the module
  * @param {CacheGroupsContext} context context object
@@ -562,6 +593,7 @@ const checkTest = (test, module, context) => {
 /** @typedef {(type: string) => boolean} CheckModuleTypeFn */
 
 /**
+ * Checks module type.
  * @param {OptimizationSplitChunksCacheGroup["type"]} test type option
  * @param {Module} module the module
  * @returns {boolean} true, if the module should be selected
@@ -585,6 +617,7 @@ const checkModuleType = (test, module) => {
 /** @typedef {(layer: string | null) => boolean} CheckModuleLayerFn */
 
 /**
+ * Checks module layer.
  * @param {OptimizationSplitChunksCacheGroup["layer"]} test type option
  * @param {Module} module the module
  * @returns {boolean} true, if the module should be selected
@@ -606,6 +639,7 @@ const checkModuleLayer = (test, module) => {
 };
 
 /**
+ * Creates a cache group source.
  * @param {OptimizationSplitChunksCacheGroup} options the group options
  * @param {string} key key of cache group
  * @param {DefaultSizeTypes} defaultSizeTypes the default size types
@@ -657,6 +691,7 @@ const PLUGIN_NAME = "SplitChunksPlugin";
 
 module.exports = class SplitChunksPlugin {
 	/**
+	 * Creates an instance of SplitChunksPlugin.
 	 * @param {OptimizationSplitChunksOptions=} options plugin options
 	 */
 	constructor(options = {}) {
@@ -746,6 +781,7 @@ module.exports = class SplitChunksPlugin {
 	}
 
 	/**
+	 * Returns the cache group (cached).
 	 * @param {CacheGroupSource} cacheGroupSource source
 	 * @returns {CacheGroup} the cache group (cached)
 	 */
@@ -837,7 +873,7 @@ module.exports = class SplitChunksPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -878,6 +914,7 @@ module.exports = class SplitChunksPlugin {
 						index <<= ONE;
 					}
 					/**
+					 * Returns key of the chunks.
 					 * @param {Iterable<Chunk, undefined, undefined>} chunks list of chunks
 					 * @returns {bigint | Chunk} key of the chunks
 					 */
@@ -898,6 +935,7 @@ module.exports = class SplitChunksPlugin {
 						return key;
 					};
 					/**
+					 * Returns stringified key.
 					 * @param {bigint | Chunk} key key of the chunks
 					 * @returns {string} stringified key
 					 */
@@ -926,6 +964,7 @@ module.exports = class SplitChunksPlugin {
 					});
 
 					/**
+					 * Group chunks by exports.
 					 * @param {Module} module the module
 					 * @returns {Iterable<Chunk[]>} groups of chunks with equal exports
 					 */
@@ -978,6 +1017,7 @@ module.exports = class SplitChunksPlugin {
 					// to allow to check less sets via isSubset
 					// (only smaller sets can be subset)
 					/**
+					 * Group chunk sets by count.
 					 * @param {IterableIterator<ChunkSet>} chunkSets set of sets of chunks
 					 * @returns {ChunkSetsByCount} map of sets of chunks by count
 					 */
@@ -1010,6 +1050,7 @@ module.exports = class SplitChunksPlugin {
 
 					// Create a list of possible combinations
 					/**
+					 * Creates a get combinations.
 					 * @param {ChunkSetsInGraph} chunkSets chunk sets
 					 * @param {ChunkSet} singleChunkSets single chunks sets
 					 * @param {ChunkSetsByCount} chunkSetsByCount chunk sets by count
@@ -1066,6 +1107,7 @@ module.exports = class SplitChunksPlugin {
 					});
 
 					/**
+					 * Returns combinations by key.
 					 * @param {bigint | Chunk} key key
 					 * @returns {Combinations} combinations by key
 					 */
@@ -1081,6 +1123,7 @@ module.exports = class SplitChunksPlugin {
 						);
 					});
 					/**
+					 * Gets exports combinations.
 					 * @param {bigint | Chunk} key key
 					 * @returns {Combinations} exports combinations by key
 					 */
@@ -1088,6 +1131,7 @@ module.exports = class SplitChunksPlugin {
 						getExportsCombinationsFactory()(key);
 
 					/**
+					 * Defines the selected chunks result type used by this module.
 					 * @typedef {object} SelectedChunksResult
 					 * @property {Chunk[]} chunks the list of chunks
 					 * @property {bigint | Chunk} key a key of the list
@@ -1144,6 +1188,7 @@ module.exports = class SplitChunksPlugin {
 					const chunksInfoMap = new Map();
 
 					/**
+					 * Adds module to chunks info map.
 					 * @param {CacheGroup} cacheGroup the current cache group
 					 * @param {number} cacheGroupIndex the index of the cache group of ordering
 					 * @param {Chunk[]} selectedChunks chunks selected for this module
@@ -1346,6 +1391,7 @@ module.exports = class SplitChunksPlugin {
 					logger.time("queue");
 
 					/**
+					 * Removes modules with source type.
 					 * @param {ChunksInfoItem} info entry
 					 * @param {SourceTypes} sourceTypes source types to be removed
 					 */
@@ -1362,6 +1408,7 @@ module.exports = class SplitChunksPlugin {
 					};
 
 					/**
+					 * Removes min size violating modules.
 					 * @param {ChunksInfoItem} info entry
 					 * @returns {boolean} true, if entry become empty
 					 */
@@ -1392,6 +1439,7 @@ module.exports = class SplitChunksPlugin {
 					}
 
 					/**
+					 * Defines the max size queue item type used by this module.
 					 * @typedef {object} MaxSizeQueueItem
 					 * @property {SplitChunksSizes} minSize
 					 * @property {SplitChunksSizes} maxAsyncSize

package/lib/performance/AssetsOverSizeLimitWarning.js

@@ -12,6 +12,7 @@ const WebpackError = require("../WebpackError");
 
 class AssetsOverSizeLimitWarning extends WebpackError {
 	/**
+	 * Creates an instance of AssetsOverSizeLimitWarning.
 	 * @param {AssetDetails[]} assetsOverSizeLimit the assets
 	 * @param {number} assetLimit the size limit
 	 */

package/lib/performance/EntrypointsOverSizeLimitWarning.js

@@ -12,6 +12,7 @@ const WebpackError = require("../WebpackError");
 
 class EntrypointsOverSizeLimitWarning extends WebpackError {
 	/**
+	 * Creates an instance of EntrypointsOverSizeLimitWarning.
 	 * @param {EntrypointDetails[]} entrypoints the entrypoints
 	 * @param {number} entrypointLimit the size limit
 	 */

package/lib/performance/SizeLimitsPlugin.js

@@ -19,12 +19,14 @@ const NoAsyncChunksWarning = require("./NoAsyncChunksWarning");
 /** @typedef {import("../WebpackError")} WebpackError */
 
 /**
+ * Defines the asset details type used by this module.
  * @typedef {object} AssetDetails
  * @property {string} name
  * @property {number} size
  */
 
 /**
+ * Defines the entrypoint details type used by this module.
  * @typedef {object} EntrypointDetails
  * @property {string} name
  * @property {number} size
@@ -43,6 +45,7 @@ const PLUGIN_NAME = "SizeLimitsPlugin";
 
 module.exports = class SizeLimitsPlugin {
 	/**
+	 * Creates an instance of SizeLimitsPlugin.
 	 * @param {PerformanceOptions} options the plugin options
 	 */
 	constructor(options) {
@@ -57,6 +60,7 @@ module.exports = class SizeLimitsPlugin {
 	}
 
 	/**
+	 * Checks whether this size limits plugin is over size limit.
 	 * @param {Entrypoint | ChunkGroup | Source} thing the resource to test
 	 * @returns {boolean} true if over the limit
 	 */
@@ -65,7 +69,7 @@ module.exports = class SizeLimitsPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -80,6 +84,7 @@ module.exports = class SizeLimitsPlugin {
 			const warnings = [];
 
 			/**
+			 * Gets entrypoint size.
 			 * @param {Entrypoint} entrypoint an entrypoint
 			 * @returns {number} the size of the entrypoint
 			 */
@@ -116,6 +121,7 @@ module.exports = class SizeLimitsPlugin {
 			}
 
 			/**
+			 * Returns result.
 			 * @param {Asset["name"]} name the name
 			 * @returns {boolean | undefined} result
 			 */

package/lib/prefetch/ChunkPrefetchFunctionRuntimeModule.js

@@ -24,6 +24,7 @@ class ChunkPrefetchFunctionRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/prefetch/ChunkPrefetchPreloadPlugin.js

@@ -15,8 +15,14 @@ const ChunkPreloadTriggerRuntimeModule = require("./ChunkPreloadTriggerRuntimeMo
 
 const PLUGIN_NAME = "ChunkPrefetchPreloadPlugin";
 
+/**
+ * Adds runtime support for chunk prefetch and preload relationships discovered
+ * in the chunk graph.
+ */
 class ChunkPrefetchPreloadPlugin {
 	/**
+	 * Registers compilation hooks that emit the runtime modules responsible for
+	 * scheduling chunk prefetch and preload requests.
 	 * @param {Compiler} compiler the compiler
 	 * @returns {void}
 	 */

package/lib/prefetch/ChunkPrefetchStartupRuntimeModule.js

@@ -23,6 +23,7 @@ class ChunkPrefetchStartupRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/prefetch/ChunkPrefetchTriggerRuntimeModule.js

@@ -22,6 +22,7 @@ class ChunkPrefetchTriggerRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/prefetch/ChunkPreloadTriggerRuntimeModule.js

@@ -22,6 +22,7 @@ class ChunkPreloadTriggerRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/rules/BasicEffectRulePlugin.js

@@ -9,6 +9,7 @@
 /** @typedef {import("./RuleSetCompiler")} RuleSetCompiler */
 
 /**
+ * Defines the keys of types type used by this module.
  * @template T
  * @template {T[keyof T]} V
  * @typedef {import("./RuleSetCompiler").KeysOfTypes<T, V>} KeysOfTypes
@@ -20,6 +21,7 @@ const PLUGIN_NAME = "BasicEffectRulePlugin";
 
 class BasicEffectRulePlugin {
 	/**
+	 * Creates an instance of BasicEffectRulePlugin.
 	 * @param {BasicEffectRuleKeys} ruleProperty the rule property
 	 * @param {string=} effectType the effect type
 	 */
@@ -31,6 +33,7 @@ class BasicEffectRulePlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {RuleSetCompiler} ruleSetCompiler the rule set compiler
 	 * @returns {void}
 	 */

package/lib/rules/BasicMatcherRulePlugin.js

@@ -11,6 +11,7 @@
 /** @typedef {import("./RuleSetCompiler")} RuleSetCompiler */
 
 /**
+ * Defines the keys of types type used by this module.
  * @template T
  * @template {T[keyof T]} V
  * @typedef {import("./RuleSetCompiler").KeysOfTypes<T, V>} KeysOfTypes
@@ -22,6 +23,7 @@ const PLUGIN_NAME = "BasicMatcherRulePlugin";
 
 class BasicMatcherRulePlugin {
 	/**
+	 * Creates an instance of BasicMatcherRulePlugin.
 	 * @param {BasicMatcherRuleKeys} ruleProperty the rule property
 	 * @param {string=} dataProperty the data property
 	 * @param {boolean=} invert if true, inverts the condition
@@ -36,6 +38,7 @@ class BasicMatcherRulePlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {RuleSetCompiler} ruleSetCompiler the rule set compiler
 	 * @returns {void}
 	 */

package/lib/rules/ObjectMatcherRulePlugin.js

@@ -12,6 +12,7 @@
 /** @typedef {import("./RuleSetCompiler").RuleConditionFunction} RuleConditionFunction */
 
 /**
+ * Defines the keys of types type used by this module.
  * @template T
  * @template {T[keyof T]} V
  * @typedef {import("./RuleSetCompiler").KeysOfTypes<T, V>} KeysOfTypes
@@ -24,6 +25,7 @@ const PLUGIN_NAME = "ObjectMatcherRulePlugin";
 
 class ObjectMatcherRulePlugin {
 	/**
+	 * Creates an instance of ObjectMatcherRulePlugin.
 	 * @param {ObjectMatcherRuleKeys} ruleProperty the rule property
 	 * @param {DataProperty=} dataProperty the data property
 	 * @param {RuleConditionFunction=} additionalConditionFunction need to check
@@ -38,6 +40,7 @@ class ObjectMatcherRulePlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {RuleSetCompiler} ruleSetCompiler the rule set compiler
 	 * @returns {void}
 	 */