webpack 5.106.0 → 5.106.2

package/lib/node/ReadFileCompileAsyncWasmPlugin.js

@@ -15,6 +15,7 @@ const AsyncWasmLoadingRuntimeModule = require("../wasm-async/AsyncWasmLoadingRun
 /** @typedef {import("../Compiler")} Compiler */
 
 /**
+ * Defines the read file compile async wasm plugin options type used by this module.
  * @typedef {object} ReadFileCompileAsyncWasmPluginOptions
  * @property {boolean=} import use import?
  */
@@ -23,6 +24,7 @@ const PLUGIN_NAME = "ReadFileCompileAsyncWasmPlugin";
 
 class ReadFileCompileAsyncWasmPlugin {
 	/**
+	 * Creates an instance of ReadFileCompileAsyncWasmPlugin.
 	 * @param {ReadFileCompileAsyncWasmPluginOptions=} options options object
 	 */
 	constructor({ import: useImport = false } = {}) {
@@ -31,7 +33,7 @@ class ReadFileCompileAsyncWasmPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -39,6 +41,7 @@ class ReadFileCompileAsyncWasmPlugin {
 		compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
 			const globalWasmLoading = compilation.outputOptions.wasmLoading;
 			/**
+			 * Checks whether this read file compile async wasm plugin is enabled for chunk.
 			 * @param {Chunk} chunk chunk
 			 * @returns {boolean} true, if wasm loading is enabled for the chunk
 			 */

package/lib/node/ReadFileCompileWasmPlugin.js

@@ -14,6 +14,7 @@ const WasmChunkLoadingRuntimeModule = require("../wasm-sync/WasmChunkLoadingRunt
 /** @typedef {import("../Compiler")} Compiler */
 
 /**
+ * Defines the read file compile wasm plugin options type used by this module.
  * @typedef {object} ReadFileCompileWasmPluginOptions
  * @property {boolean=} mangleImports mangle imports
  * @property {boolean=} import use import?
@@ -23,6 +24,7 @@ const PLUGIN_NAME = "ReadFileCompileWasmPlugin";
 
 class ReadFileCompileWasmPlugin {
 	/**
+	 * Creates an instance of ReadFileCompileWasmPlugin.
 	 * @param {ReadFileCompileWasmPluginOptions=} options options object
 	 */
 	constructor(options = {}) {
@@ -31,7 +33,7 @@ class ReadFileCompileWasmPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -39,6 +41,7 @@ class ReadFileCompileWasmPlugin {
 		compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
 			const globalWasmLoading = compilation.outputOptions.wasmLoading;
 			/**
+			 * Checks whether this read file compile wasm plugin is enabled for chunk.
 			 * @param {Chunk} chunk chunk
 			 * @returns {boolean} true, when wasm loading is enabled for the chunk
 			 */

package/lib/node/RequireChunkLoadingRuntimeModule.js

@@ -26,6 +26,7 @@ const { getUndoPath } = require("../util/identifier");
 
 class RequireChunkLoadingRuntimeModule extends RuntimeModule {
 	/**
+	 * Creates an instance of RequireChunkLoadingRuntimeModule.
 	 * @param {ReadOnlyRuntimeRequirements} runtimeRequirements runtime requirements
 	 */
 	constructor(runtimeRequirements) {
@@ -35,6 +36,7 @@ class RequireChunkLoadingRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Returns generated code.
 	 * @private
 	 * @param {Chunk} chunk chunk
 	 * @param {string} rootOutputDir root output directory
@@ -55,6 +57,7 @@ class RequireChunkLoadingRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/node/nodeConsole.js

@@ -14,6 +14,7 @@ const truncateArgs = require("../logging/truncateArgs");
 /* eslint-disable no-console */
 
 /**
+ * Returns logger function.
  * @param {object} options options
  * @param {boolean=} options.colors colors
  * @param {boolean=} options.appendOnly append only
@@ -28,6 +29,7 @@ module.exports = ({ colors, appendOnly, stream }) => {
 	let currentCollapsed = 0;
 
 	/**
+	 * Returns indented string.
 	 * @param {string} str string
 	 * @param {string} prefix prefix
 	 * @param {string} colorPrefix color prefix
@@ -67,6 +69,7 @@ module.exports = ({ colors, appendOnly, stream }) => {
 	};
 
 	/**
+	 * Returns function to write with colors.
 	 * @template T
 	 * @param {string} prefix prefix
 	 * @param {string} colorPrefix color prefix

package/lib/optimize/AggressiveMergingPlugin.js

@@ -11,6 +11,7 @@ const { STAGE_ADVANCED } = require("../OptimizationStages");
 /** @typedef {import("../Compiler")} Compiler */
 
 /**
+ * Defines the aggressive merging plugin options type used by this module.
  * @typedef {object} AggressiveMergingPluginOptions
  * @property {number=} minSizeReduce minimal size reduction to trigger merging
  */
@@ -19,6 +20,7 @@ const PLUGIN_NAME = "AggressiveMergingPlugin";
 
 class AggressiveMergingPlugin {
 	/**
+	 * Creates an instance of AggressiveMergingPlugin.
 	 * @param {AggressiveMergingPluginOptions=} options options object
 	 */
 	constructor(options) {
@@ -35,7 +37,7 @@ class AggressiveMergingPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/optimize/AggressiveSplittingPlugin.js

@@ -21,6 +21,7 @@ const identifierUtils = require("../util/identifier");
 /** @typedef {import("../Module")} Module */
 
 /**
+ * Move module between.
  * @param {ChunkGraph} chunkGraph the chunk graph
  * @param {Chunk} oldChunk the old chunk
  * @param {Chunk} newChunk the new chunk
@@ -32,6 +33,7 @@ const moveModuleBetween = (chunkGraph, oldChunk, newChunk) => (module) => {
 };
 
 /**
+ * Checks whether this object is not a entry module.
  * @param {ChunkGraph} chunkGraph the chunk graph
  * @param {Chunk} chunk the chunk
  * @returns {(module: Module) => boolean} filter for entry module
@@ -48,6 +50,7 @@ const PLUGIN_NAME = "AggressiveSplittingPlugin";
 
 class AggressiveSplittingPlugin {
 	/**
+	 * Creates an instance of AggressiveSplittingPlugin.
 	 * @param {AggressiveSplittingPluginOptions=} options options object
 	 */
 	constructor(options = {}) {
@@ -56,6 +59,7 @@ class AggressiveSplittingPlugin {
 	}
 
 	/**
+	 * Was chunk recorded.
 	 * @param {Chunk} chunk the chunk to test
 	 * @returns {boolean} true if the chunk was recorded
 	 */
@@ -64,7 +68,7 @@ class AggressiveSplittingPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -138,6 +142,7 @@ class AggressiveSplittingPlugin {
 					const maxSize = this.options.maxSize || 50 * 1024;
 
 					/**
+					 * Returns true when applied, otherwise false.
 					 * @param {SplitData} splitData split data
 					 * @returns {boolean} true when applied, otherwise false
 					 */

package/lib/optimize/ConcatenatedModule.js

@@ -795,6 +795,7 @@ class ConcatenatedModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -806,6 +807,7 @@ class ConcatenatedModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -813,6 +815,7 @@ class ConcatenatedModule 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
 	 */
@@ -823,6 +826,7 @@ class ConcatenatedModule extends Module {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -831,6 +835,7 @@ class ConcatenatedModule extends Module {
 	}
 
 	/**
+	 * Returns the path used when matching this module against rule conditions.
 	 * @returns {NameForCondition | null} absolute path which should be used for condition matching (usually the resource path)
 	 */
 	nameForCondition() {
@@ -838,6 +843,7 @@ class ConcatenatedModule 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
 	 */
@@ -846,6 +852,7 @@ class ConcatenatedModule 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
@@ -958,6 +965,7 @@ class ConcatenatedModule 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)
 	 */
@@ -1243,6 +1251,7 @@ class ConcatenatedModule extends Module {
 	}
 
 	/**
+	 * Adds the provided file dependencies to the module.
 	 * @param {FileSystemDependencies} fileDependencies set where file dependencies are added to
 	 * @param {FileSystemDependencies} contextDependencies set where context dependencies are added to
 	 * @param {FileSystemDependencies} missingDependencies set where missing dependencies are added to
@@ -1265,6 +1274,7 @@ class ConcatenatedModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -2244,6 +2254,7 @@ ${defineGetters}`
 	}
 
 	/**
+	 * 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}

package/lib/optimize/EnsureChunkConditionsPlugin.js

@@ -15,13 +15,14 @@ const PLUGIN_NAME = "EnsureChunkConditionsPlugin";
 
 class EnsureChunkConditionsPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
 			/**
+			 * Handles the hook callback for this code path.
 			 * @param {Iterable<Chunk>} chunks the chunks
 			 */
 			const handler = (chunks) => {

package/lib/optimize/FlagIncludedChunksPlugin.js

@@ -16,7 +16,7 @@ const PLUGIN_NAME = "FlagIncludedChunksPlugin";
 
 class FlagIncludedChunksPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -46,6 +46,7 @@ class FlagIncludedChunksPlugin {
 				const modulos = Array.from(
 					{ length: 31 },
 					/**
+					 * Handles the callback logic for this hook.
 					 * @param {number} x x
 					 * @param {number} i i
 					 * @returns {number} result

package/lib/optimize/InnerGraph.js

@@ -22,6 +22,7 @@ const JavascriptParser = require("../javascript/JavascriptParser");
 /** @typedef {(value: boolean | Set<string> | undefined) => void} UsageCallback */
 
 /**
+ * Defines the state object type used by this module.
  * @typedef {object} StateObject
  * @property {InnerGraph} innerGraph
  * @property {TopLevelSymbol=} currentTopLevelSymbol
@@ -32,6 +33,7 @@ const JavascriptParser = require("../javascript/JavascriptParser");
 
 class TopLevelSymbol {
 	/**
+	 * Creates an instance of TopLevelSymbol.
 	 * @param {string} name name of the variable
 	 */
 	constructor(name) {
@@ -47,6 +49,7 @@ const parserStateMap = new WeakMap();
 const topLevelSymbolTag = Symbol("top level symbol");
 
 /**
+ * Returns state.
  * @param {ParserState} parserState parser state
  * @returns {State | undefined} state
  */
@@ -55,6 +58,7 @@ function getState(parserState) {
 }
 
 /**
+ * Processes the provided state.
  * @param {ParserState} state parser state
  * @param {TopLevelSymbol | null} symbol the symbol, or null for all symbols
  * @param {Usage} usage usage data
@@ -79,6 +83,7 @@ module.exports.addUsage = (state, symbol, usage) => {
 /** @typedef {string | TopLevelSymbol | true} Usage */
 
 /**
+ * Processes the provided parser.
  * @param {JavascriptParser} parser the parser
  * @param {string} name name of variable
  * @param {Usage} usage usage data
@@ -95,6 +100,7 @@ module.exports.addVariableUsage = (parser, name, usage) => {
 };
 
 /**
+ * Processes the provided parser state.
  * @param {ParserState} parserState parser state
  * @returns {void}
  */
@@ -103,6 +109,7 @@ module.exports.bailout = (parserState) => {
 };
 
 /**
+ * Processes the provided parser state.
  * @param {ParserState} parserState parser state
  * @returns {void}
  */
@@ -121,6 +128,7 @@ module.exports.enable = (parserState) => {
 /** @typedef {Set<string> | boolean} UsedByExports */
 
 /**
+ * Usage callback map.
  * @param {Dependency} dependency the dependency
  * @param {UsedByExports | undefined} usedByExports usedByExports info
  * @param {ModuleGraph} moduleGraph moduleGraph
@@ -150,6 +158,7 @@ module.exports.getDependencyUsedByExportsCondition = (
 };
 
 /**
+ * Returns usage data.
  * @param {ParserState} state parser state
  * @returns {TopLevelSymbol | void} usage data
  */
@@ -162,6 +171,7 @@ module.exports.getTopLevelSymbol = (state) => {
 };
 
 /**
+ * Processes the provided state.
  * @param {ParserState} state parser state
  * @returns {void}
  */
@@ -260,6 +270,7 @@ module.exports.inferDependencyUsage = (state) => {
 };
 
 /**
+ * Returns false, when unused. Otherwise true.
  * @param {Dependency} dependency the dependency
  * @param {UsedByExports | undefined} usedByExports usedByExports info
  * @param {ModuleGraph} moduleGraph moduleGraph
@@ -290,6 +301,7 @@ module.exports.isDependencyUsedByExports = (
 };
 
 /**
+ * Returns true, when enabled.
  * @param {ParserState} parserState parser state
  * @returns {boolean} true, when enabled
  */
@@ -299,6 +311,7 @@ module.exports.isEnabled = (parserState) => {
 };
 
 /**
+ * Processes the provided state.
  * @param {ParserState} state parser state
  * @param {UsageCallback} onUsageCallback on usage callback
  */
@@ -326,6 +339,7 @@ module.exports.onUsage = (state, onUsageCallback) => {
 };
 
 /**
+ * Processes the provided state.
  * @param {ParserState} state parser state
  * @param {TopLevelSymbol | undefined} symbol the symbol
  */
@@ -338,6 +352,7 @@ module.exports.setTopLevelSymbol = (state, symbol) => {
 };
 
 /**
+ * Returns symbol.
  * @param {JavascriptParser} parser parser
  * @param {string} name name of variable
  * @returns {TopLevelSymbol | undefined} symbol

package/lib/optimize/InnerGraphPlugin.js

@@ -32,7 +32,7 @@ const PLUGIN_NAME = "InnerGraphPlugin";
 
 class InnerGraphPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -48,12 +48,14 @@ class InnerGraphPlugin {
 				);
 
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {JavascriptParserOptions} parserOptions options
 				 * @returns {void}
 				 */
 				const handler = (parser, parserOptions) => {
 					/**
+					 * Processes the provided sup.
 					 * @param {Expression} sup sup
 					 */
 					const onUsageSuper = (sup) => {

package/lib/optimize/LimitChunkCountPlugin.js

@@ -14,6 +14,7 @@ const { compareChunks } = require("../util/comparators");
 /** @typedef {import("../Compiler")} Compiler */
 
 /**
+ * Defines the chunk combination type used by this module.
  * @typedef {object} ChunkCombination
  * @property {boolean} deleted this is set to true when combination was removed
  * @property {number} sizeDiff
@@ -27,6 +28,7 @@ const { compareChunks } = require("../util/comparators");
  */
 
 /**
+ * Adds the provided map to this object.
  * @template K, V
  * @param {Map<K, Set<V>>} map map
  * @param {K} key key
@@ -45,6 +47,7 @@ const PLUGIN_NAME = "LimitChunkCountPlugin";
 
 class LimitChunkCountPlugin {
 	/**
+	 * Creates an instance of LimitChunkCountPlugin.
 	 * @param {LimitChunkCountPluginOptions=} options options object
 	 */
 	constructor(options = { maxChunks: 1 }) {
@@ -53,6 +56,7 @@ class LimitChunkCountPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the webpack compiler
 	 * @returns {void}
 	 */
@@ -105,11 +109,13 @@ class LimitChunkCountPlugin {
 
 						// Layer 2: ordered by smallest combined size
 						/**
+						 * Handles the stage callback for this hook.
 						 * @param {ChunkCombination} c combination
 						 * @returns {number} integrated size
 						 */
 						(c) => c.integratedSize,
 						/**
+						 * Handles the callback logic for this hook.
 						 * @param {number} a a
 						 * @param {number} b b
 						 * @returns {number} result
@@ -118,11 +124,13 @@ class LimitChunkCountPlugin {
 
 						// Layer 3: ordered by position difference in orderedChunk (-> to be deterministic)
 						/**
+						 * Handles the callback logic for this hook.
 						 * @param {ChunkCombination} c combination
 						 * @returns {number} position difference
 						 */
 						(c) => c.bIdx - c.aIdx,
 						/**
+						 * Handles the callback logic for this hook.
 						 * @param {number} a a
 						 * @param {number} b b
 						 * @returns {number} result
@@ -131,6 +139,7 @@ class LimitChunkCountPlugin {
 
 						// Layer 4: ordered by position in orderedChunk (-> to be deterministic)
 						/**
+						 * Handles the callback logic for this hook.
 						 * @param {ChunkCombination} a a
 						 * @param {ChunkCombination} b b
 						 * @returns {number} result

package/lib/optimize/MangleExportsPlugin.js

@@ -20,11 +20,13 @@ const { compareSelect, compareStringsNumeric } = require("../util/comparators");
 /** @typedef {import("../util/concatenate").UsedNames} UsedNames */
 
 /**
+ * Defines the comparator type used by this module.
  * @template T
  * @typedef {import("../util/comparators").Comparator<T>} Comparator
  */
 
 /**
+ * Checks whether it can mangle.
  * @param {ExportsInfo} exportsInfo exports info
  * @returns {boolean} mangle is possible
  */
@@ -45,6 +47,7 @@ const canMangle = (exportsInfo) => {
 /** @type {Comparator<ExportInfo>} */
 const comparator = compareSelect((e) => e.name, compareStringsNumeric);
 /**
+ * Mangle exports info.
  * @param {boolean} deterministic use deterministic names
  * @param {ExportsInfo} exportsInfo exports info
  * @param {boolean | undefined} isNamespace is namespace object
@@ -158,6 +161,7 @@ const PLUGIN_NAME = "MangleExportsPlugin";
 
 class MangleExportsPlugin {
 	/**
+	 * Creates an instance of MangleExportsPlugin.
 	 * @param {boolean} deterministic use deterministic names
 	 */
 	constructor(deterministic) {
@@ -166,7 +170,7 @@ class MangleExportsPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/optimize/MergeDuplicateChunksPlugin.js

@@ -16,6 +16,7 @@ const PLUGIN_NAME = "MergeDuplicateChunksPlugin";
 
 class MergeDuplicateChunksPlugin {
 	/**
+	 * Creates an instance of MergeDuplicateChunksPlugin.
 	 * @param {MergeDuplicateChunksPluginOptions=} options options object
 	 */
 	constructor(options = { stage: STAGE_BASIC }) {
@@ -24,6 +25,7 @@ class MergeDuplicateChunksPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler
 	 * @returns {void}
 	 */

package/lib/optimize/MinChunkSizePlugin.js

@@ -15,6 +15,7 @@ const PLUGIN_NAME = "MinChunkSizePlugin";
 
 class MinChunkSizePlugin {
 	/**
+	 * Creates an instance of MinChunkSizePlugin.
 	 * @param {MinChunkSizePluginOptions} options options object
 	 */
 	constructor(options) {
@@ -23,7 +24,7 @@ class MinChunkSizePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/optimize/MinMaxSizeWarning.js

@@ -10,6 +10,7 @@ const WebpackError = require("../WebpackError");
 
 class MinMaxSizeWarning extends WebpackError {
 	/**
+	 * Creates an instance of MinMaxSizeWarning.
 	 * @param {string[] | undefined} keys keys
 	 * @param {number} minSize minimum size
 	 * @param {number} maxSize maximum size