webpack 5.106.0 → 5.106.2

package/lib/NormalModuleFactory.js

@@ -62,6 +62,7 @@ const {
 /** @typedef {import("./util/identifier").AssociatedObjectForCache} AssociatedObjectForCache */
 
 /**
+ * Defines the callback type used by this module.
  * @template T
  * @typedef {import("./Compiler").Callback<T>} Callback
  */
@@ -70,6 +71,7 @@ const {
 /** @typedef {Partial<NormalModuleCreateData & { settings: ModuleSettings }>} CreateData */
 
 /**
+ * Defines the resolve data type used by this module.
  * @typedef {object} ResolveData
  * @property {ModuleFactoryCreateData["contextInfo"]} contextInfo
  * @property {ModuleFactoryCreateData["resolveOptions"]} resolveOptions
@@ -88,6 +90,7 @@ const {
  */
 
 /**
+ * Defines the resource data type used by this module.
  * @typedef {object} ResourceData
  * @property {string} resource
  * @property {string=} path
@@ -97,6 +100,7 @@ const {
  */
 
 /**
+ * Defines the resource scheme data type used by this module.
  * @typedef {object} ResourceSchemeData
  * @property {string=} mimetype mime type of the resource
  * @property {string=} parameters additional parameters for the resource
@@ -107,6 +111,7 @@ const {
 /** @typedef {ResourceData & { data: ResourceSchemeData & Partial<ResolveRequest> }} ResourceDataWithData */
 
 /**
+ * Defines the parsed loader request type used by this module.
  * @typedef {object} ParsedLoaderRequest
  * @property {string} loader loader
  * @property {string | undefined} options options
@@ -143,6 +148,7 @@ const MATCH_RESOURCE_REGEX = /^([^!]+)!=!/;
 const LEADING_DOT_EXTENSION_REGEX = /^[^.]/;
 
 /**
+ * Returns ident.
  * @param {LoaderItem} data data
  * @returns {string} ident
  */
@@ -163,6 +169,7 @@ const loaderToIdent = (data) => {
 };
 
 /**
+ * Stringify loaders and resource.
  * @param {LoaderItem[]} loaders loaders
  * @param {string} resource resource
  * @returns {string} stringified loaders and resource
@@ -176,6 +183,7 @@ const stringifyLoadersAndResource = (loaders, resource) => {
 };
 
 /**
+ * Checks whether it needs calls.
  * @param {number} times times
  * @param {(err?: null | Error) => void} callback callback
  * @returns {(err?: null | Error) => void} callback
@@ -191,6 +199,7 @@ const needCalls = (times, callback) => (err) => {
 };
 
 /**
+ * Merges global options.
  * @template T
  * @template O
  * @param {T} globalOptions global options
@@ -221,6 +230,7 @@ const mergeGlobalOptions = (globalOptions, type, localOptions) => {
 
 // TODO webpack 6 remove
 /**
+ * Deprecation changed hook message.
  * @template {import("tapable").Hook<EXPECTED_ANY, EXPECTED_ANY>} T
  * @param {string} name name
  * @param {T} hook hook
@@ -311,6 +321,7 @@ const ruleSetCompiler = new RuleSetCompiler([
 
 /* eslint-disable jsdoc/type-formatting */
 /**
+ * Defines the shared type used by this module.
  * @typedef {[
  * [JAVASCRIPT_MODULE_TYPE_AUTO, JavascriptParser, JavascriptParserOptions, JavascriptGenerator, EmptyGeneratorOptions],
  * [JAVASCRIPT_MODULE_TYPE_DYNAMIC, JavascriptParser, JavascriptParserOptions, JavascriptGenerator, EmptyGeneratorOptions],
@@ -333,12 +344,14 @@ const ruleSetCompiler = new RuleSetCompiler([
 /* eslint-enable jsdoc/type-formatting */
 
 /**
+ * Defines the extract tuple elements type used by this module.
  * @template {unknown[]} T
  * @template {number[]} I
  * @typedef {{ [K in keyof I]: K extends keyof I ? I[K] extends keyof T ? T[I[K]] : never : never }} ExtractTupleElements
  */
 
 /**
+ * Represents the normal module factory runtime component.
  * @template {unknown[]} T
  * @template {number[]} A
  * @template [R=void]
@@ -347,6 +360,7 @@ const ruleSetCompiler = new RuleSetCompiler([
 
 class NormalModuleFactory extends ModuleFactory {
 	/**
+	 * Creates an instance of NormalModuleFactory.
 	 * @param {object} param params
 	 * @param {string=} param.context context
 	 * @param {InputFileSystem} param.fs file system
@@ -868,6 +882,7 @@ class NormalModuleFactory extends ModuleFactory {
 				);
 
 				/**
+				 * Processes the provided string.
 				 * @param {string} context context
 				 */
 				const defaultResolve = (context) => {
@@ -972,6 +987,7 @@ class NormalModuleFactory extends ModuleFactory {
 	}
 
 	/**
+	 * Processes the provided data.
 	 * @param {ModuleFactoryCreateData} data data object
 	 * @param {ModuleFactoryCallback} callback callback
 	 * @returns {void}
@@ -1080,6 +1096,7 @@ class NormalModuleFactory extends ModuleFactory {
 	}
 
 	/**
+	 * Processes the provided context info.
 	 * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
 	 * @param {string} context context
 	 * @param {string} unresolvedResource unresolved resource
@@ -1152,6 +1169,7 @@ ${hints.join("\n\n")}`;
 	}
 
 	/**
+	 * Resolve resource error hints.
 	 * @param {Error} error error
 	 * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
 	 * @param {string} context context
@@ -1277,6 +1295,7 @@ If changing the source code is not an option there is also a resolve options cal
 	}
 
 	/**
+	 * Resolves request array.
 	 * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
 	 * @param {string} context context
 	 * @param {LoaderItem[]} array array
@@ -1298,6 +1317,7 @@ If changing the source code is not an option there is also a resolve options cal
 		asyncLib.map(
 			array,
 			/**
+			 * Handles the callback logic for this hook.
 			 * @param {LoaderItem} item item
 			 * @param {Callback<LoaderItem>} callback callback
 			 */
@@ -1376,6 +1396,7 @@ If changing the source code is not an option there is also a resolve options cal
 	}
 
 	/**
+	 * Returns parser.
 	 * @param {string} type type
 	 * @param {ParserOptions} parserOptions parser options
 	 * @returns {Parser} parser
@@ -1399,6 +1420,7 @@ If changing the source code is not an option there is also a resolve options cal
 	}
 
 	/**
+	 * Creates a parser from the provided type.
 	 * @param {string} type type
 	 * @param {ParserOptions} parserOptions parser options
 	 * @returns {Parser} parser
@@ -1418,6 +1440,7 @@ If changing the source code is not an option there is also a resolve options cal
 	}
 
 	/**
+	 * Returns generator.
 	 * @param {string} type type of generator
 	 * @param {GeneratorOptions} generatorOptions generator options
 	 * @returns {Generator} generator
@@ -1441,6 +1464,7 @@ If changing the source code is not an option there is also a resolve options cal
 	}
 
 	/**
+	 * Creates a generator.
 	 * @param {string} type type of generator
 	 * @param {GeneratorOptions} generatorOptions generator options
 	 * @returns {Generator} generator
@@ -1462,6 +1486,7 @@ If changing the source code is not an option there is also a resolve options cal
 	}
 
 	/**
+	 * Returns the resolver.
 	 * @param {Parameters<ResolverFactory["get"]>[0]} type type of resolver
 	 * @param {Parameters<ResolverFactory["get"]>[1]=} resolveOptions options
 	 * @returns {ReturnType<ResolverFactory["get"]>} the resolver

package/lib/NormalModuleReplacementPlugin.js

@@ -27,7 +27,7 @@ class NormalModuleReplacementPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/NullFactory.js

@@ -12,6 +12,7 @@ const ModuleFactory = require("./ModuleFactory");
 
 class NullFactory extends ModuleFactory {
 	/**
+	 * Processes the provided data.
 	 * @param {ModuleFactoryCreateData} data data object
 	 * @param {ModuleFactoryCallback} callback callback
 	 * @returns {void}

package/lib/OptionsApply.js

@@ -11,6 +11,7 @@
 
 class OptionsApply {
 	/**
+	 * Returns options object.
 	 * @param {WebpackOptions} options options object
 	 * @param {Compiler} compiler compiler object
 	 * @param {WebpackOptionsInterception=} interception intercepted options

package/lib/Parser.js

@@ -12,6 +12,7 @@
 /** @typedef {Record<string, EXPECTED_ANY>} PreparsedAst */
 
 /**
+ * Defines the parser state base type used by this module.
  * @typedef {object} ParserStateBase
  * @property {string | Buffer} source
  * @property {NormalModule} current
@@ -25,6 +26,7 @@
 class Parser {
 	/* istanbul ignore next */
 	/**
+	 * Parses the provided source and updates the parser state.
 	 * @abstract
 	 * @param {string | Buffer | PreparsedAst} source the source to parse
 	 * @param {ParserState} state the parser state

package/lib/PlatformPlugin.js

@@ -16,6 +16,7 @@ const PLUGIN_NAME = "PlatformPlugin";
  */
 class PlatformPlugin {
 	/**
+	 * Creates an instance of PlatformPlugin.
 	 * @param {Partial<PlatformTargetProperties>} platform target properties
 	 */
 	constructor(platform) {
@@ -24,7 +25,7 @@ class PlatformPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/PrefetchPlugin.js

@@ -13,6 +13,7 @@ const PLUGIN_NAME = "PrefetchPlugin";
 
 class PrefetchPlugin {
 	/**
+	 * Creates an instance of PrefetchPlugin.
 	 * @param {string} context context or request if context is not set
 	 * @param {string=} request request
 	 */
@@ -27,7 +28,7 @@ class PrefetchPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/ProgressPlugin.js

@@ -12,6 +12,7 @@ const { contextify } = require("./util/identifier");
 
 /** @typedef {import("tapable").Tap} Tap */
 /**
+ * Defines the hook type used by this module.
  * @template T, R, AdditionalOptions
  * @typedef {import("tapable").Hook<T, R, AdditionalOptions>} Hook
  */
@@ -25,17 +26,20 @@ const { contextify } = require("./util/identifier");
 /** @typedef {import("./logging/Logger").Logger} Logger */
 
 /**
+ * Defines the async queue type used by this module.
  * @template T, K, R
  * @typedef {import("./util/AsyncQueue")<T, K, R>} AsyncQueue
  */
 
 /**
+ * Defines the counts data type used by this module.
  * @typedef {object} CountsData
  * @property {number} modulesCount modules count
  * @property {number} dependenciesCount dependencies count
  */
 
 /**
+ * Returns median.
  * @param {number} a a
  * @param {number} b b
  * @param {number} c c
@@ -46,6 +50,7 @@ const median3 = (a, b, c) => a + b + c - Math.max(a, b, c) - Math.min(a, b, c);
 /** @typedef {(percentage: number, msg: string, ...args: string[]) => void} HandlerFn */
 
 /**
+ * Creates a default handler.
  * @param {boolean | null | undefined} profile need profile
  * @param {Logger} logger logger
  * @returns {HandlerFn} default handler
@@ -122,6 +127,7 @@ const createDefaultHandler = (profile, logger) => {
 const SKIPPED_QUEUE_CONTEXTS = ["import-module", "load-module"];
 
 /**
+ * Defines the report progress callback.
  * @callback ReportProgress
  * @param {number} p percentage
  * @param {...string} args additional arguments
@@ -147,6 +153,7 @@ const DEFAULT_OPTIONS = {
 
 class ProgressPlugin {
 	/**
+	 * Returns a progress reporter, if any.
 	 * @param {Compiler} compiler the current compiler
 	 * @returns {ReportProgress | undefined} a progress reporter, if any
 	 */
@@ -155,6 +162,7 @@ class ProgressPlugin {
 	}
 
 	/**
+	 * Creates an instance of ProgressPlugin.
 	 * @param {ProgressPluginArgument} options options
 	 */
 	constructor(options = {}) {
@@ -167,21 +175,20 @@ class ProgressPlugin {
 		/** @type {ProgressPluginOptions} */
 		this.options = options;
 
-		this.profile = options.profile || DEFAULT_OPTIONS.profile;
-		this.handler = options.handler;
-		this.modulesCount = options.modulesCount || DEFAULT_OPTIONS.modulesCount;
-		this.dependenciesCount =
-			options.dependenciesCount || DEFAULT_OPTIONS.dependenciesCount;
-		this.showEntries = options.entries || DEFAULT_OPTIONS.entries;
-		this.showModules = options.modules || DEFAULT_OPTIONS.modules;
-		this.showDependencies =
-			options.dependencies || DEFAULT_OPTIONS.dependencies;
-		this.showActiveModules =
-			options.activeModules || DEFAULT_OPTIONS.activeModules;
-		this.percentBy = options.percentBy || DEFAULT_OPTIONS.percentBy;
+		const merged = { ...DEFAULT_OPTIONS, ...options };
+		this.profile = merged.profile;
+		this.handler = merged.handler;
+		this.modulesCount = merged.modulesCount;
+		this.dependenciesCount = merged.dependenciesCount;
+		this.showEntries = merged.entries;
+		this.showModules = merged.modules;
+		this.showDependencies = merged.dependencies;
+		this.showActiveModules = merged.activeModules;
+		this.percentBy = merged.percentBy;
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler | MultiCompiler} compiler webpack compiler
 	 * @returns {void}
 	 */
@@ -200,6 +207,7 @@ class ProgressPlugin {
 	}
 
 	/**
+	 * Apply on multi compiler.
 	 * @param {MultiCompiler} compiler webpack multi-compiler
 	 * @param {HandlerFn} handler function that executes for every progress step
 	 * @returns {void}
@@ -219,6 +227,7 @@ class ProgressPlugin {
 	}
 
 	/**
+	 * Processes the provided compiler.
 	 * @param {Compiler} compiler webpack compiler
 	 * @param {HandlerFn} handler function that executes for every progress step
 	 * @returns {void}
@@ -333,6 +342,7 @@ class ProgressPlugin {
 		};
 
 		/**
+		 * Processes the provided factorize queue.
 		 * @template T
 		 * @param {AsyncQueue<FactorizeModuleOptions, string, Module | ModuleFactoryResult>} factorizeQueue async queue
 		 * @param {T} _item item
@@ -355,6 +365,7 @@ class ProgressPlugin {
 		};
 
 		/**
+		 * Processes the provided add module queue.
 		 * @template T
 		 * @param {AsyncQueue<Module, string, Module>} addModuleQueue async queue
 		 * @param {T} _item item
@@ -369,6 +380,7 @@ class ProgressPlugin {
 
 		// only used when showActiveModules is set
 		/**
+		 * Processes the provided module.
 		 * @param {Module} module the module
 		 */
 		const moduleBuild = (module) => {
@@ -381,6 +393,7 @@ class ProgressPlugin {
 		};
 
 		/**
+		 * Processes the provided entry.
 		 * @param {Dependency} entry entry dependency
 		 * @param {EntryOptions} options options object
 		 */
@@ -390,6 +403,7 @@ class ProgressPlugin {
 		};
 
 		/**
+		 * Processes the provided module.
 		 * @param {Module} module the module
 		 */
 		const moduleDone = (module) => {
@@ -412,6 +426,7 @@ class ProgressPlugin {
 		};
 
 		/**
+		 * Processes the provided entry.
 		 * @param {Dependency} entry entry dependency
 		 * @param {EntryOptions} options options object
 		 */
@@ -606,6 +621,7 @@ class ProgressPlugin {
 			}
 		});
 		/**
+		 * Processes the provided hook.
 		 * @template {Hook<EXPECTED_ANY, EXPECTED_ANY, EXPECTED_ANY>} T
 		 * @param {T} hook hook
 		 * @param {number} progress progress from 0 to 1
@@ -629,6 +645,7 @@ class ProgressPlugin {
 					handler(progress, category, name);
 				},
 				/**
+				 * Processes the provided tap.
 				 * @param {Tap} tap tap
 				 */
 				tap(tap) {

package/lib/ProvidePlugin.js

@@ -24,6 +24,7 @@ const PLUGIN_NAME = "ProvidePlugin";
 
 class ProvidePlugin {
 	/**
+	 * Creates an instance of ProvidePlugin.
 	 * @param {Record<string, string | string[]>} definitions the provided identifiers
 	 */
 	constructor(definitions) {
@@ -31,7 +32,7 @@ class ProvidePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -53,6 +54,7 @@ class ProvidePlugin {
 					new ProvidedDependency.Template()
 				);
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {JavascriptParserOptions} parserOptions options
 				 * @returns {void}

package/lib/RawModule.js

@@ -36,6 +36,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 class RawModule extends Module {
 	/**
+	 * Creates an instance of RawModule.
 	 * @param {string} source source code
 	 * @param {string} identifier unique identifier
 	 * @param {string=} readableIdentifier readable identifier
@@ -50,6 +51,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -57,6 +59,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -64,6 +67,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {string=} type the source type for which the size should be estimated
 	 * @returns {number} the estimated size of the module (must be non-zero)
 	 */
@@ -72,6 +76,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -82,6 +87,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Checks whether the module needs to be rebuilt for the current build state.
 	 * @param {NeedBuildContext} context context info
 	 * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
@@ -91,6 +97,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
 	 * @param {ResolverWithOptions} resolver the resolver
@@ -107,6 +114,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Gets side effects connection state.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {ConnectionState} how this module should be connected to referencing modules when consumed for side-effects only
 	 */
@@ -119,6 +127,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -137,6 +146,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash used to track dependencies
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -147,6 +157,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -161,6 +172,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/RecordIdsPlugin.js

@@ -13,6 +13,7 @@ const identifierUtils = require("./util/identifier");
 /** @typedef {import("./Module")} Module */
 
 /**
+ * Defines the records chunks type used by this module.
  * @typedef {object} RecordsChunks
  * @property {Record<string, number>=} byName
  * @property {Record<string, number>=} bySource
@@ -20,18 +21,21 @@ const identifierUtils = require("./util/identifier");
  */
 
 /**
+ * Defines the records modules type used by this module.
  * @typedef {object} RecordsModules
  * @property {Record<string, number>=} byIdentifier
  * @property {number[]=} usedIds
  */
 
 /**
+ * Defines the records type used by this module.
  * @typedef {object} Records
  * @property {RecordsChunks=} chunks
  * @property {RecordsModules=} modules
  */
 
 /**
+ * Defines the record ids plugin options type used by this module.
  * @typedef {object} RecordIdsPluginOptions
  * @property {boolean=} portableIds true, when ids need to be portable
  */
@@ -42,6 +46,7 @@ const PLUGIN_NAME = "RecordIdsPlugin";
 
 class RecordIdsPlugin {
 	/**
+	 * Creates an instance of RecordIdsPlugin.
 	 * @param {RecordIdsPluginOptions=} options object
 	 */
 	constructor(options) {
@@ -49,6 +54,7 @@ class RecordIdsPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the Compiler
 	 * @returns {void}
 	 */
@@ -62,6 +68,7 @@ class RecordIdsPlugin {
 			);
 
 		/**
+		 * Gets module identifier.
 		 * @param {Module} module the module
 		 * @returns {string} the (portable) identifier
 		 */
@@ -113,6 +120,7 @@ class RecordIdsPlugin {
 			/** @typedef {string[]} ChunkSources */
 
 			/**
+			 * Gets chunk sources.
 			 * @param {Chunk} chunk the chunk
 			 * @returns {ChunkSources} sources of the chunk
 			 */

package/lib/RequestShortener.js

@@ -9,8 +9,14 @@ const { contextify } = require("./util/identifier");
 
 /** @typedef {import("./util/identifier").AssociatedObjectForCache} AssociatedObjectForCache */
 
+/**
+ * Shortens absolute or verbose request strings so diagnostics and stats output
+ * can be rendered relative to a chosen base directory.
+ */
 class RequestShortener {
 	/**
+	 * Binds a context-aware shortening function to the provided directory and
+	 * optional cache owner.
 	 * @param {string} dir the directory
 	 * @param {AssociatedObjectForCache=} associatedObjectForCache an object to which the cache will be attached
 	 */
@@ -22,6 +28,8 @@ class RequestShortener {
 	}
 
 	/**
+	 * Returns a request string rewritten relative to the configured directory
+	 * when one is provided.
 	 * @param {string | undefined | null} request the request to shorten
 	 * @returns {string | undefined | null} the shortened request
 	 */

package/lib/RequireJsStuffPlugin.js

@@ -23,7 +23,7 @@ const PLUGIN_NAME = "RequireJsStuffPlugin";
 
 module.exports = class RequireJsStuffPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -36,6 +36,7 @@ module.exports = class RequireJsStuffPlugin {
 					new ConstDependency.Template()
 				);
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {JavascriptParserOptions} parserOptions options
 				 * @returns {void}