webpack 5.106.0 → 5.106.2

package/lib/ResolverFactory.js

@@ -20,6 +20,7 @@ const {
 
 /** @typedef {WebpackResolveOptions & { dependencyType?: string, resolveToContext?: boolean }} ResolveOptionsWithDependencyType */
 /**
+ * Defines the with options type used by this module.
  * @typedef {object} WithOptions
  * @property {(options: Partial<ResolveOptionsWithDependencyType>) => ResolverWithOptions} withOptions create a resolver with additional/different options
  */
@@ -31,6 +32,7 @@ const {
 const EMPTY_RESOLVE_OPTIONS = {};
 
 /**
+ * Convert to resolve options.
  * @param {ResolveOptionsWithDependencyType} resolveOptionsWithDepType enhanced options
  * @returns {ResolveOptions} merged options
  */
@@ -69,6 +71,7 @@ const convertToResolveOptions = (resolveOptionsWithDepType) => {
 };
 
 /**
+ * Represents the resolver factory runtime component.
  * @typedef {object} ResolverCache
  * @property {WeakMap<ResolveOptionsWithDependencyType, ResolverWithOptions>} direct
  * @property {Map<string, ResolverWithOptions>} stringified
@@ -91,6 +94,7 @@ module.exports = class ResolverFactory {
 	}
 
 	/**
+	 * Returns the resolver.
 	 * @param {string} type type of resolver
 	 * @param {ResolveOptionsWithDependencyType=} resolveOptions options
 	 * @returns {ResolverWithOptions} the resolver
@@ -121,6 +125,7 @@ module.exports = class ResolverFactory {
 	}
 
 	/**
+	 * Returns the resolver.
 	 * @param {string} type type of resolver
 	 * @param {ResolveOptionsWithDependencyType} resolveOptionsWithDepType options
 	 * @returns {ResolverWithOptions} the resolver

package/lib/RuntimeGlobals.js

@@ -410,6 +410,7 @@ module.exports.startup = "__webpack_require__.x";
 module.exports.startupEntrypoint = "__webpack_require__.X";
 
 /**
+ * Describes how this item operation behaves.
  * @deprecated
  * creating a default startup function with the entry modules
  */

package/lib/RuntimeModule.js

@@ -36,6 +36,7 @@ const { WEBPACK_MODULE_TYPE_RUNTIME } = require("./ModuleTypeConstants");
 
 class RuntimeModule extends Module {
 	/**
+	 * Creates an instance of RuntimeModule.
 	 * @param {string} name a readable name
 	 * @param {number=} stage an optional stage
 	 */
@@ -64,6 +65,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Processes the provided compilation.
 	 * @param {Compilation} compilation the compilation
 	 * @param {Chunk} chunk the chunk
 	 * @param {ChunkGraph} chunkGraph the chunk graph
@@ -76,6 +78,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -83,6 +86,7 @@ class RuntimeModule 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
 	 */
@@ -91,6 +95,7 @@ class RuntimeModule 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}
@@ -100,6 +105,7 @@ class RuntimeModule 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
@@ -114,6 +120,7 @@ class RuntimeModule 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}
@@ -136,6 +143,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -156,6 +164,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -178,6 +187,7 @@ class RuntimeModule 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)
 	 */
@@ -192,6 +202,7 @@ class RuntimeModule extends Module {
 
 	/* istanbul ignore next */
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @abstract
 	 * @returns {string | null} runtime code
 	 */
@@ -202,6 +213,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Gets generated code.
 	 * @returns {string | null} runtime code
 	 */
 	getGeneratedCode() {
@@ -212,6 +224,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns true, if the runtime module should get it's own scope.
 	 * @returns {boolean} true, if the runtime module should get it's own scope
 	 */
 	shouldIsolate() {

package/lib/RuntimePlugin.js

@@ -117,6 +117,7 @@ const PLUGIN_NAME = "RuntimePlugin";
 
 class RuntimePlugin {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the Compiler
 	 * @returns {void}
 	 */
@@ -124,6 +125,7 @@ class RuntimePlugin {
 		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
 			const globalChunkLoading = compilation.outputOptions.chunkLoading;
 			/**
+			 * Checks whether this runtime plugin is chunk loading disabled for chunk.
 			 * @param {Chunk} chunk chunk
 			 * @returns {boolean} true, when chunk loading is disabled for the chunk
 			 */

package/lib/RuntimeTemplate.js

@@ -45,6 +45,7 @@ const getImportDependency = memoize(() =>
 /** @typedef {import("./NormalModuleFactory").ModuleDependency} ModuleDependency */
 
 /**
+ * No module id error message.
  * @param {Module} module the module
  * @param {ChunkGraph} chunkGraph the chunk graph
  * @returns {string} error message
@@ -71,6 +72,7 @@ Module has these incoming connections: ${Array.from(
 ).join("")}`;
 
 /**
+ * Gets global object.
  * @param {string | undefined} definition global object definition
  * @returns {string | undefined} save to use global object
  */
@@ -94,6 +96,7 @@ function getGlobalObject(definition) {
 
 class RuntimeTemplate {
 	/**
+	 * Creates an instance of RuntimeTemplate.
 	 * @param {Compilation} compilation the compilation
 	 * @param {OutputOptions} outputOptions the compilation output options
 	 * @param {RequestShortener} requestShortener the request shortener
@@ -172,6 +175,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Renders node prefix for core module.
 	 * @param {string} mod a module
 	 * @returns {string} a module with `node:` prefix when supported, otherwise an original name
 	 */
@@ -182,6 +186,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Renders return const when it is supported, otherwise var.
 	 * @returns {"const" | "var"} return `const` when it is supported, otherwise `var`
 	 */
 	renderConst() {
@@ -189,6 +194,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returning function.
 	 * @param {string} returnValue return value
 	 * @param {string} args arguments
 	 * @returns {string} returning function
@@ -200,6 +206,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns basic function.
 	 * @param {string} args arguments
 	 * @param {string | string[]} body body
 	 * @returns {string} basic function
@@ -211,6 +218,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns result expression.
 	 * @param {(string | { expr: string })[]} args args
 	 * @returns {string} result expression
 	 */
@@ -260,6 +268,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns result expression.
 	 * @param {(string | { expr: string })[]} args args (len >= 2)
 	 * @returns {string} result expression
 	 * @private
@@ -277,6 +286,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Expression function.
 	 * @param {string} expression expression
 	 * @param {string} args arguments
 	 * @returns {string} expression function code
@@ -288,6 +298,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns empty function code.
 	 * @returns {string} empty function code
 	 */
 	emptyFunction() {
@@ -295,6 +306,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns destructure array code.
 	 * @param {string[]} items items
 	 * @param {string} value value
 	 * @returns {string} destructure array code
@@ -308,6 +320,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Destructure object.
 	 * @param {string[]} items items
 	 * @param {string} value value
 	 * @returns {string} destructure object code
@@ -323,6 +336,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns iIFE code.
 	 * @param {string} args arguments
 	 * @param {string} body body
 	 * @returns {string} IIFE code
@@ -332,6 +346,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns for each code.
 	 * @param {string} variable variable
 	 * @param {string} array array
 	 * @param {string | string[]} body body
@@ -346,7 +361,7 @@ class RuntimeTemplate {
 	}
 
 	/**
-	 * Add a comment
+	 * Returns comment.
 	 * @param {object} options Information content of the comment
 	 * @param {string=} options.request request string used originally
 	 * @param {(string | null)=} options.chunkName name of the chunk referenced
@@ -377,6 +392,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Throw missing module error block.
 	 * @param {object} options generation options
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} generated error block
@@ -389,6 +405,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Throw missing module error function.
 	 * @param {object} options generation options
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} generated error function
@@ -400,6 +417,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns generated error IIFE.
 	 * @param {object} options generation options
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} generated error IIFE
@@ -409,6 +427,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Missing module statement.
 	 * @param {object} options generation options
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} generated error statement
@@ -418,6 +437,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Missing module promise.
 	 * @param {object} options generation options
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} generated error code
@@ -429,6 +449,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns the code.
 	 * @param {object} options options object
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
 	 * @param {Module} options.module the module
@@ -465,6 +486,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns the expression.
 	 * @param {object} options options object
 	 * @param {Module} options.module the module
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
@@ -494,6 +516,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns the expression.
 	 * @param {object} options options object
 	 * @param {Module | null} options.module the module
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
@@ -537,6 +560,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns the expression.
 	 * @param {object} options options object
 	 * @param {Module | null} options.module the module
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
@@ -556,6 +580,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns the expression.
 	 * @param {object} options options object
 	 * @param {Module} options.module the module
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
@@ -625,6 +650,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Module namespace promise.
 	 * @param {object} options options object
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
 	 * @param {AsyncDependenciesBlock=} options.block the current dependencies block
@@ -817,6 +843,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Runtime condition expression.
 	 * @param {object} options options object
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
 	 * @param {RuntimeSpec=} options.runtime runtime for which this code will be generated
@@ -854,6 +881,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns the import statement and the compat statement.
 	 * @param {object} options options object
 	 * @param {boolean=} options.update whether a new variable should be created or the existing one updated
 	 * @param {Module} options.module the module
@@ -959,6 +987,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Export from import.
 	 * @template GenerateContext
 	 * @param {object} options options
 	 * @param {ModuleGraph} options.moduleGraph the module graph
@@ -1154,6 +1183,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Returns expression.
 	 * @param {object} options options
 	 * @param {AsyncDependenciesBlock | undefined} options.block the async block
 	 * @param {string} options.message the message
@@ -1205,6 +1235,7 @@ class RuntimeTemplate {
 			}
 
 			/**
+			 * Returns require chunk id code.
 			 * @param {Chunk} chunk chunk
 			 * @returns {string} require chunk id code
 			 */
@@ -1220,6 +1251,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Async module factory.
 	 * @param {object} options options
 	 * @param {AsyncDependenciesBlock} options.block the async block
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
@@ -1252,6 +1284,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Sync module factory.
 	 * @param {object} options options
 	 * @param {Dependency} options.dependency the dependency
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
@@ -1273,6 +1306,7 @@ class RuntimeTemplate {
 	}
 
 	/**
+	 * Define es module flag statement.
 	 * @param {object} options options
 	 * @param {string} options.exportsArgument the name of the exports object
 	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements

package/lib/SelfModuleFactory.js

@@ -11,6 +11,7 @@
 
 class SelfModuleFactory {
 	/**
+	 * Creates an instance of SelfModuleFactory.
 	 * @param {ModuleGraph} moduleGraph module graph
 	 */
 	constructor(moduleGraph) {
@@ -18,6 +19,7 @@ class SelfModuleFactory {
 	}
 
 	/**
+	 * Processes the provided data.
 	 * @param {ModuleFactoryCreateData} data data object
 	 * @param {ModuleFactoryCallback} callback callback
 	 * @returns {void}

package/lib/SizeFormatHelpers.js

@@ -6,6 +6,7 @@
 "use strict";
 
 /**
+ * Returns the formatted size.
  * @param {number=} size the size in bytes
  * @returns {string} the formatted size
  */

package/lib/SourceMapDevToolModuleOptionsPlugin.js

@@ -14,6 +14,7 @@ const PLUGIN_NAME = "SourceMapDevToolModuleOptionsPlugin";
 
 class SourceMapDevToolModuleOptionsPlugin {
 	/**
+	 * Creates an instance of SourceMapDevToolModuleOptionsPlugin.
 	 * @param {SourceMapDevToolPluginOptions=} options options
 	 */
 	constructor(options = {}) {
@@ -22,6 +23,7 @@ class SourceMapDevToolModuleOptionsPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compilation} compilation the compiler instance
 	 * @returns {void}
 	 */

package/lib/SourceMapDevToolPlugin.js

@@ -34,6 +34,7 @@ const { makePathsAbsolute } = require("./util/identifier");
 /** @typedef {import("./util/fs").OutputFileSystem} OutputFileSystem */
 
 /**
+ * Defines the source map task type used by this module.
  * @typedef {object} SourceMapTask
  * @property {Source} asset
  * @property {AssetInfo} assetInfo
@@ -128,6 +129,7 @@ const PLUGIN_NAME = "SourceMapDevToolPlugin";
 
 class SourceMapDevToolPlugin {
 	/**
+	 * Creates an instance of SourceMapDevToolPlugin.
 	 * @param {SourceMapDevToolPluginOptions=} options options object
 	 * @throws {Error} throws error, if got more than 1 arguments
 	 */
@@ -154,7 +156,7 @@ class SourceMapDevToolPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler compiler instance
 	 * @returns {void}
 	 */

package/lib/Stats.js

@@ -12,6 +12,7 @@
 
 class Stats {
 	/**
+	 * Creates an instance of Stats.
 	 * @param {Compilation} compilation webpack compilation
 	 */
 	constructor(compilation) {
@@ -31,6 +32,7 @@ class Stats {
 	}
 
 	/**
+	 * Checks whether this stats has warnings.
 	 * @returns {boolean} true if the compilation had a warning
 	 */
 	hasWarnings() {
@@ -41,6 +43,7 @@ class Stats {
 	}
 
 	/**
+	 * Checks whether this stats has errors.
 	 * @returns {boolean} true if the compilation encountered an error
 	 */
 	hasErrors() {
@@ -51,6 +54,7 @@ class Stats {
 	}
 
 	/**
+	 * Returns json output.
 	 * @param {StatsValue=} options stats options
 	 * @returns {StatsCompilation} json output
 	 */
@@ -67,6 +71,7 @@ class Stats {
 	}
 
 	/**
+	 * Returns a string representation.
 	 * @param {StatsValue=} options stats options
 	 * @returns {string} string output
 	 */

package/lib/Template.js

@@ -43,6 +43,7 @@ const PATH_NAME_NORMALIZE_REPLACE_REGEX = /[^a-z0-9_!§$()=\-^°]+/gi;
 const MATCH_PADDED_HYPHENS_REPLACE_REGEX = /^-|-$/g;
 
 /**
+ * Defines the render manifest options type used by this module.
  * @typedef {object} RenderManifestOptions
  * @property {Chunk} chunk the chunk used to render
  * @property {string} hash
@@ -59,6 +60,7 @@ const MATCH_PADDED_HYPHENS_REPLACE_REGEX = /^-|-$/g;
 /** @typedef {RenderManifestEntryTemplated | RenderManifestEntryStatic} RenderManifestEntry */
 
 /**
+ * Defines the render manifest entry templated type used by this module.
  * @typedef {object} RenderManifestEntryTemplated
  * @property {() => Source} render
  * @property {TemplatePath} filenameTemplate
@@ -70,6 +72,7 @@ const MATCH_PADDED_HYPHENS_REPLACE_REGEX = /^-|-$/g;
  */
 
 /**
+ * Defines the render manifest entry static type used by this module.
  * @typedef {object} RenderManifestEntryStatic
  * @property {() => Source} render
  * @property {string} filename
@@ -80,16 +83,19 @@ const MATCH_PADDED_HYPHENS_REPLACE_REGEX = /^-|-$/g;
  */
 
 /**
+ * Defines the module filter predicate type used by this module.
  * @typedef {(module: Module) => boolean} ModuleFilterPredicate
  */
 
 /**
+ * Represents the template runtime component.
  * @typedef {object} Stringable
  * @property {() => string} toString
  */
 
 class Template {
 	/**
+	 * Gets function content.
 	 * @param {Stringable} fn a runtime function (.runtime.js) "template"
 	 * @returns {string} the updated and normalized function string
 	 */
@@ -102,6 +108,7 @@ class Template {
 	}
 
 	/**
+	 * Returns created identifier.
 	 * @param {string} str the string converted to identifier
 	 * @returns {string} created identifier
 	 */
@@ -113,6 +120,7 @@ class Template {
 	}
 
 	/**
+	 * Returns a commented version of string.
 	 * @param {string} str string to be converted to commented in bundle code
 	 * @returns {string} returns a commented version of string
 	 */
@@ -122,6 +130,7 @@ class Template {
 	}
 
 	/**
+	 * Returns a commented version of string.
 	 * @param {string} str string to be converted to "normal comment"
 	 * @returns {string} returns a commented version of string
 	 */
@@ -131,6 +140,7 @@ class Template {
 	}
 
 	/**
+	 * Returns normalized bundle-safe path.
 	 * @param {string} str string path to be normalized
 	 * @returns {string} normalized bundle-safe path
 	 */
@@ -143,6 +153,7 @@ class Template {
 
 	// map number to a single character a-z, A-Z or multiple characters if number is too big
 	/**
+	 * Number to identifier.
 	 * @param {number} n number to convert to ident
 	 * @returns {string} returns single character ident
 	 */
@@ -173,6 +184,7 @@ class Template {
 	}
 
 	/**
+	 * Number to identifier continuation.
 	 * @param {number} n number to convert to ident
 	 * @returns {string} returns single character ident
 	 */
@@ -211,6 +223,7 @@ class Template {
 	}
 
 	/**
+	 * Returns converted identity.
 	 * @param {string | string[]} s string to convert to identity
 	 * @returns {string} converted identity
 	 */
@@ -225,6 +238,7 @@ class Template {
 	}
 
 	/**
+	 * Returns new prefix string.
 	 * @param {string | string[]} s string to create prefix for
 	 * @param {string} prefix prefix to compose
 	 * @returns {string} returns new prefix string
@@ -237,6 +251,7 @@ class Template {
 	}
 
 	/**
+	 * Returns a single string from array.
 	 * @param {string | string[]} str string or string collection
 	 * @returns {string} returns a single string from array
 	 */
@@ -248,11 +263,13 @@ class Template {
 	}
 
 	/**
+	 * Defines the with id type used by this module.
 	 * @typedef {object} WithId
 	 * @property {string | number} id
 	 */
 
 	/**
+	 * Gets modules array bounds.
 	 * @param {WithId[]} modules a collection of modules to get array bounds for
 	 * @returns {[number, number] | false} returns the upper and lower array bounds
 	 * or false if not every module has a number based id
@@ -282,6 +299,7 @@ class Template {
 	}
 
 	/**
+	 * Renders chunk modules.
 	 * @param {ChunkRenderContext} renderContext render context
 	 * @param {Module[]} modules modules to render (should be ordered by identifier)
 	 * @param {(module: Module, renderInArray?: boolean) => Source | null} renderModule function to render a module
@@ -355,6 +373,7 @@ class Template {
 	}
 
 	/**
+	 * Renders runtime modules.
 	 * @param {RuntimeModule[]} runtimeModules array of runtime modules in order
 	 * @param {RenderContext & { codeGenerationResults?: CodeGenerationResults }} renderContext render context
 	 * @returns {Source} rendered runtime modules in a Source object
@@ -404,6 +423,7 @@ class Template {
 	}
 
 	/**
+	 * Renders chunk runtime modules.
 	 * @param {RuntimeModule[]} runtimeModules array of runtime modules in order
 	 * @param {RenderContext} renderContext render context
 	 * @returns {Source} rendered chunk runtime modules in a Source object