webpack 5.90.3 → 5.92.0

package/lib/HotModuleReplacementPlugin.js

@@ -42,19 +42,28 @@ const {
 	WEBPACK_MODULE_TYPE_RUNTIME
 } = require("./ModuleTypeConstants");
 
+/** @typedef {import("estree").CallExpression} CallExpression */
+/** @typedef {import("estree").Expression} Expression */
 /** @typedef {import("./Chunk")} Chunk */
+/** @typedef {import("./Chunk").ChunkId} ChunkId */
 /** @typedef {import("./Compilation").AssetInfo} AssetInfo */
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Dependency").DependencyLocation} DependencyLocation */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./Module").BuildInfo} BuildInfo */
 /** @typedef {import("./RuntimeModule")} RuntimeModule */
+/** @typedef {import("./javascript/BasicEvaluatedExpression")} BasicEvaluatedExpression */
+/** @typedef {import("./javascript/JavascriptParserHelpers").Range} Range */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
 /**
- * @typedef {Object} HMRJavascriptParserHooks
+ * @typedef {object} HMRJavascriptParserHooks
  * @property {SyncBailHook<[TODO, string[]], void>} hotAcceptCallback
  * @property {SyncBailHook<[TODO, string[]], void>} hotAcceptWithoutCallback
  */
 
+/** @typedef {Map<string, { updatedChunkIds: Set<ChunkId>, removedChunkIds: Set<ChunkId>, removedModules: Set<Module>, filename: string, assetInfo: AssetInfo }>} HotUpdateMainContentByRuntime */
+
 /** @type {WeakMap<JavascriptParser, HMRJavascriptParserHooks>} */
 const parserHooksMap = new WeakMap();
 
@@ -82,6 +91,9 @@ class HotModuleReplacementPlugin {
 		return hooks;
 	}
 
+	/**
+	 * @param {object=} options options
+	 */
 	constructor(options) {
 		this.options = options || {};
 	}
@@ -97,6 +109,11 @@ class HotModuleReplacementPlugin {
 			compiler.options.output.strictModuleErrorHandling = true;
 		const runtimeRequirements = [RuntimeGlobals.module];
 
+		/**
+		 * @param {JavascriptParser} parser the parser
+		 * @param {typeof ModuleHotAcceptDependency} ParamDependency dependency
+		 * @returns {(expr: CallExpression) => boolean | undefined} callback
+		 */
 		const createAcceptHandler = (parser, ParamDependency) => {
 			const { hotAcceptCallback, hotAcceptWithoutCallback } =
 				HotModuleReplacementPlugin.getParserHooks(parser);
@@ -105,27 +122,38 @@ class HotModuleReplacementPlugin {
 				const module = parser.state.module;
 				const dep = new ConstDependency(
 					`${module.moduleArgument}.hot.accept`,
-					expr.callee.range,
+					/** @type {Range} */ (expr.callee.range),
 					runtimeRequirements
 				);
-				dep.loc = expr.loc;
+				dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 				module.addPresentationalDependency(dep);
-				module.buildInfo.moduleConcatenationBailout = "Hot Module Replacement";
+				/** @type {BuildInfo} */
+				(module.buildInfo).moduleConcatenationBailout =
+					"Hot Module Replacement";
 				if (expr.arguments.length >= 1) {
 					const arg = parser.evaluateExpression(expr.arguments[0]);
+					/** @type {BasicEvaluatedExpression[]} */
 					let params = [];
-					let requests = [];
 					if (arg.isString()) {
 						params = [arg];
 					} else if (arg.isArray()) {
-						params = arg.items.filter(param => param.isString());
+						params =
+							/** @type {BasicEvaluatedExpression[]} */
+							(arg.items).filter(param => param.isString());
 					}
+					/** @type {string[]} */
+					let requests = [];
 					if (params.length > 0) {
 						params.forEach((param, idx) => {
-							const request = param.string;
-							const dep = new ParamDependency(request, param.range);
+							const request = /** @type {string} */ (param.string);
+							const dep = new ParamDependency(
+								request,
+								/** @type {Range} */ (param.range)
+							);
 							dep.optional = true;
-							dep.loc = Object.create(expr.loc);
+							dep.loc = Object.create(
+								/** @type {DependencyLocation} */ (expr.loc)
+							);
 							dep.loc.index = idx;
 							module.addDependency(dep);
 							requests.push(request);
@@ -147,28 +175,40 @@ class HotModuleReplacementPlugin {
 			};
 		};
 
+		/**
+		 * @param {JavascriptParser} parser the parser
+		 * @param {typeof ModuleHotDeclineDependency} ParamDependency dependency
+		 * @returns {(expr: CallExpression) => boolean | undefined} callback
+		 */
 		const createDeclineHandler = (parser, ParamDependency) => expr => {
 			const module = parser.state.module;
 			const dep = new ConstDependency(
 				`${module.moduleArgument}.hot.decline`,
-				expr.callee.range,
+				/** @type {Range} */ (expr.callee.range),
 				runtimeRequirements
 			);
-			dep.loc = expr.loc;
+			dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 			module.addPresentationalDependency(dep);
-			module.buildInfo.moduleConcatenationBailout = "Hot Module Replacement";
+			/** @type {BuildInfo} */
+			(module.buildInfo).moduleConcatenationBailout = "Hot Module Replacement";
 			if (expr.arguments.length === 1) {
 				const arg = parser.evaluateExpression(expr.arguments[0]);
+				/** @type {BasicEvaluatedExpression[]} */
 				let params = [];
 				if (arg.isString()) {
 					params = [arg];
 				} else if (arg.isArray()) {
-					params = arg.items.filter(param => param.isString());
+					params =
+						/** @type {BasicEvaluatedExpression[]} */
+						(arg.items).filter(param => param.isString());
 				}
 				params.forEach((param, idx) => {
-					const dep = new ParamDependency(param.string, param.range);
+					const dep = new ParamDependency(
+						/** @type {string} */ (param.string),
+						/** @type {Range} */ (param.range)
+					);
 					dep.optional = true;
-					dep.loc = Object.create(expr.loc);
+					dep.loc = Object.create(/** @type {DependencyLocation} */ (expr.loc));
 					dep.loc.index = idx;
 					module.addDependency(dep);
 				});
@@ -176,16 +216,21 @@ class HotModuleReplacementPlugin {
 			return true;
 		};
 
+		/**
+		 * @param {JavascriptParser} parser the parser
+		 * @returns {(expr: Expression) => boolean | undefined} callback
+		 */
 		const createHMRExpressionHandler = parser => expr => {
 			const module = parser.state.module;
 			const dep = new ConstDependency(
 				`${module.moduleArgument}.hot`,
-				expr.range,
+				/** @type {Range} */ (expr.range),
 				runtimeRequirements
 			);
-			dep.loc = expr.loc;
+			dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 			module.addPresentationalDependency(dep);
-			module.buildInfo.moduleConcatenationBailout = "Hot Module Replacement";
+			/** @type {BuildInfo} */
+			(module.buildInfo).moduleConcatenationBailout = "Hot Module Replacement";
 			return true;
 		};
 
@@ -303,7 +348,9 @@ class HotModuleReplacementPlugin {
 				//#endregion
 
 				let hotIndex = 0;
+				/** @type {Record<string, string>} */
 				const fullHashChunkModuleHashes = {};
+				/** @type {Record<string, string>} */
 				const chunkModuleHashes = {};
 
 				compilation.hooks.record.tap(PLUGIN_NAME, (compilation, records) => {
@@ -316,18 +363,20 @@ class HotModuleReplacementPlugin {
 					records.chunkHashes = {};
 					records.chunkRuntime = {};
 					for (const chunk of compilation.chunks) {
-						records.chunkHashes[chunk.id] = chunk.hash;
-						records.chunkRuntime[chunk.id] = getRuntimeKey(chunk.runtime);
+						const chunkId = /** @type {ChunkId} */ (chunk.id);
+						records.chunkHashes[chunkId] = chunk.hash;
+						records.chunkRuntime[chunkId] = getRuntimeKey(chunk.runtime);
 					}
 					records.chunkModuleIds = {};
 					for (const chunk of compilation.chunks) {
-						records.chunkModuleIds[chunk.id] = Array.from(
-							chunkGraph.getOrderedChunkModulesIterable(
-								chunk,
-								compareModulesById(chunkGraph)
-							),
-							m => chunkGraph.getModuleId(m)
-						);
+						records.chunkModuleIds[/** @type {ChunkId} */ (chunk.id)] =
+							Array.from(
+								chunkGraph.getOrderedChunkModulesIterable(
+									chunk,
+									compareModulesById(chunkGraph)
+								),
+								m => chunkGraph.getModuleId(m)
+							);
 					}
 				});
 				/** @type {TupleSet<[Module, Chunk]>} */
@@ -340,6 +389,10 @@ class HotModuleReplacementPlugin {
 					const chunkGraph = compilation.chunkGraph;
 					const records = compilation.records;
 					for (const chunk of compilation.chunks) {
+						/**
+						 * @param {Module} module module
+						 * @returns {string} module hash
+						 */
 						const getModuleHash = module => {
 							if (
 								compilation.codeGenerationResults.has(module, chunk.runtime)
@@ -454,7 +507,7 @@ class HotModuleReplacementPlugin {
 							chunkModuleHashes[key] = hash;
 						}
 
-						/** @type {Map<string, { updatedChunkIds: Set<string|number>, removedChunkIds: Set<string|number>, removedModules: Set<Module>, filename: string, assetInfo: AssetInfo }>} */
+						/** @type {HotUpdateMainContentByRuntime} */
 						const hotUpdateMainContentByRuntime = new Map();
 						let allOldRuntime;
 						for (const key of Object.keys(records.chunkRuntime)) {
@@ -470,13 +523,16 @@ class HotModuleReplacementPlugin {
 										runtime
 									}
 								);
-							hotUpdateMainContentByRuntime.set(runtime, {
-								updatedChunkIds: new Set(),
-								removedChunkIds: new Set(),
-								removedModules: new Set(),
-								filename,
-								assetInfo
-							});
+							hotUpdateMainContentByRuntime.set(
+								/** @type {string} */ (runtime),
+								{
+									updatedChunkIds: new Set(),
+									removedChunkIds: new Set(),
+									removedModules: new Set(),
+									filename,
+									assetInfo
+								}
+							);
 						});
 						if (hotUpdateMainContentByRuntime.size === 0) return;
 
@@ -506,6 +562,7 @@ class HotModuleReplacementPlugin {
 								}
 							}
 
+							/** @type {ChunkId | null} */
 							let chunkId;
 							let newModules;
 							let newRuntimeModules;
@@ -554,9 +611,10 @@ class HotModuleReplacementPlugin {
 							if (removedFromRuntime) {
 								// chunk was removed from some runtimes
 								forEachRuntime(removedFromRuntime, runtime => {
-									hotUpdateMainContentByRuntime
-										.get(runtime)
-										.removedChunkIds.add(chunkId);
+									const item = hotUpdateMainContentByRuntime.get(
+										/** @type {string} */ (runtime)
+									);
+									item.removedChunkIds.add(/** @type {ChunkId} */ (chunkId));
 								});
 								// dispose modules from the chunk in these runtimes
 								// where they are no longer in this runtime
@@ -597,12 +655,16 @@ class HotModuleReplacementPlugin {
 												if (typeof moduleRuntime === "string") {
 													if (moduleRuntime === runtime) return;
 												} else if (moduleRuntime !== undefined) {
-													if (moduleRuntime.has(runtime)) return;
+													if (
+														moduleRuntime.has(/** @type {string} */ (runtime))
+													)
+														return;
 												}
 											}
-											hotUpdateMainContentByRuntime
-												.get(runtime)
-												.removedModules.add(module);
+											const item = hotUpdateMainContentByRuntime.get(
+												/** @type {string} */ (runtime)
+											);
+											item.removedModules.add(module);
 										});
 									}
 								}
@@ -676,9 +738,10 @@ class HotModuleReplacementPlugin {
 									}
 								}
 								forEachRuntime(newRuntime, runtime => {
-									hotUpdateMainContentByRuntime
-										.get(runtime)
-										.updatedChunkIds.add(chunkId);
+									const item = hotUpdateMainContentByRuntime.get(
+										/** @type {string} */ (runtime)
+									);
+									item.updatedChunkIds.add(/** @type {ChunkId} */ (chunkId));
 								});
 							}
 						}

package/lib/IgnorePlugin.js

@@ -28,7 +28,10 @@ class IgnorePlugin {
 		validate(options);
 		this.options = options;
 
-		/** @private @type {Function} */
+		/**
+		 * @private
+		 * @type {Function}
+		 */
 		this.checkIgnore = this.checkIgnore.bind(this);
 	}
 

package/lib/InitFragment.js

@@ -40,7 +40,7 @@ const sortFragmentWithIndex = ([a, i], [b, j]) => {
  */
 class InitFragment {
 	/**
-	 * @param {string | Source} content the source code that will be included as initialization code
+	 * @param {string | Source | undefined} content the source code that will be included as initialization code
 	 * @param {number} stage category of initialization code (contribute to order)
 	 * @param {number} position position in the category (contribute to order)
 	 * @param {string=} key unique key to avoid emitting the same initialization code twice
@@ -56,7 +56,7 @@ class InitFragment {
 
 	/**
 	 * @param {GenerateContext} context context
-	 * @returns {string | Source} the source code that will be included as initialization code
+	 * @returns {string | Source | undefined} the source code that will be included as initialization code
 	 */
 	getContent(context) {
 		return this.content;
@@ -171,7 +171,9 @@ class InitFragment {
 
 makeSerializable(InitFragment, "webpack/lib/InitFragment");
 
-InitFragment.prototype.merge = undefined;
+InitFragment.prototype.merge =
+	/** @type {TODO} */
+	(undefined);
 
 InitFragment.STAGE_CONSTANTS = 10;
 InitFragment.STAGE_ASYNC_BOUNDARY = 20;

package/lib/LibManifestPlugin.js

@@ -12,17 +12,18 @@ const { compareModulesById } = require("./util/comparators");
 const { dirname, mkdirp } = require("./util/fs");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Compiler").IntermediateFileSystem} IntermediateFileSystem */
 /** @typedef {import("./Module").BuildMeta} BuildMeta */
 
 /**
- * @typedef {Object} ManifestModuleData
+ * @typedef {object} ManifestModuleData
  * @property {string | number} id
  * @property {BuildMeta} buildMeta
  * @property {boolean | string[] | undefined} exports
  */
 
 /**
- * @typedef {Object} LibManifestPluginOptions
+ * @typedef {object} LibManifestPluginOptions
  * @property {string=} context Context of requests in the manifest file (defaults to the webpack context).
  * @property {boolean=} entryOnly If true, only entry points will be exposed (default: true).
  * @property {boolean=} format If true, manifest json file (output) will be formatted.
@@ -52,6 +53,8 @@ class LibManifestPlugin {
 			},
 			(compilation, callback) => {
 				const moduleGraph = compilation.moduleGraph;
+				// store used paths to detect issue and output an error. #18200
+				const usedPaths = new Set();
 				asyncLib.forEach(
 					Array.from(compilation.chunks),
 					(chunk, callback) => {
@@ -63,6 +66,11 @@ class LibManifestPlugin {
 						const targetPath = compilation.getPath(this.options.path, {
 							chunk
 						});
+						if (usedPaths.has(targetPath)) {
+							callback(new Error(`each chunk must have a unique path`));
+							return;
+						}
+						usedPaths.add(targetPath);
 						const name =
 							this.options.name &&
 							compilation.getPath(this.options.name, {
@@ -113,16 +121,16 @@ class LibManifestPlugin {
 							? JSON.stringify(manifest, null, 2)
 							: JSON.stringify(manifest);
 						const buffer = Buffer.from(manifestContent, "utf8");
+						const intermediateFileSystem =
+							/** @type {IntermediateFileSystem} */ (
+								compiler.intermediateFileSystem
+							);
 						mkdirp(
-							compiler.intermediateFileSystem,
-							dirname(compiler.intermediateFileSystem, targetPath),
+							intermediateFileSystem,
+							dirname(intermediateFileSystem, targetPath),
 							err => {
 								if (err) return callback(err);
-								compiler.intermediateFileSystem.writeFile(
-									targetPath,
-									buffer,
-									callback
-								);
+								intermediateFileSystem.writeFile(targetPath, buffer, callback);
 							}
 						);
 					},

package/lib/Module.js

@@ -45,7 +45,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
 /**
- * @typedef {Object} SourceContext
+ * @typedef {object} SourceContext
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
  * @property {ModuleGraph} moduleGraph the module graph
@@ -56,41 +56,43 @@ const makeSerializable = require("./util/makeSerializable");
 
 // TODO webpack 6: compilation will be required in CodeGenerationContext
 /**
- * @typedef {Object} CodeGenerationContext
+ * @typedef {object} CodeGenerationContext
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
  * @property {ModuleGraph} moduleGraph the module graph
  * @property {ChunkGraph} chunkGraph the chunk graph
- * @property {RuntimeSpec} runtime the runtime code should be generated for
- * @property {RuntimeSpec[]} [runtimes] the runtimes code should be generated for
+ * @property {RuntimeSpec} runtime the runtimes code should be generated for
  * @property {ConcatenationScope=} concatenationScope when in concatenated module, information about other concatenated modules
- * @property {CodeGenerationResults} codeGenerationResults code generation results of other modules (need to have a codeGenerationDependency to use that)
+ * @property {CodeGenerationResults | undefined} codeGenerationResults code generation results of other modules (need to have a codeGenerationDependency to use that)
  * @property {Compilation=} compilation the compilation
  * @property {ReadonlySet<string>=} sourceTypes source types
  */
 
 /**
- * @typedef {Object} ConcatenationBailoutReasonContext
+ * @typedef {object} ConcatenationBailoutReasonContext
  * @property {ModuleGraph} moduleGraph the module graph
  * @property {ChunkGraph} chunkGraph the chunk graph
  */
 
+/** @typedef {Set<string>} RuntimeRequirements */
+/** @typedef {ReadonlySet<string>} ReadOnlyRuntimeRequirements */
+
 /**
- * @typedef {Object} CodeGenerationResult
+ * @typedef {object} CodeGenerationResult
  * @property {Map<string, Source>} sources the resulting sources for all source types
  * @property {Map<string, any>=} data the resulting data for all source types
- * @property {ReadonlySet<string>} runtimeRequirements the runtime requirements
+ * @property {ReadOnlyRuntimeRequirements} runtimeRequirements the runtime requirements
  * @property {string=} hash a hash of the code generation result (will be automatically calculated from sources and runtimeRequirements if not provided)
  */
 
 /**
- * @typedef {Object} LibIdentOptions
+ * @typedef {object} LibIdentOptions
  * @property {string} context absolute context path to which lib ident is relative to
- * @property {Object=} associatedObjectForCache object for caching
+ * @property {object=} associatedObjectForCache object for caching
  */
 
 /**
- * @typedef {Object} KnownBuildMeta
+ * @typedef {object} KnownBuildMeta
  * @property {string=} moduleArgument
  * @property {string=} exportsArgument
  * @property {boolean=} strict
@@ -103,7 +105,7 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
- * @typedef {Object} KnownBuildInfo
+ * @typedef {object} KnownBuildInfo
  * @property {boolean=} cacheable
  * @property {boolean=} parsed
  * @property {LazySet<string>=} fileDependencies
@@ -118,7 +120,7 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
- * @typedef {Object} NeedBuildContext
+ * @typedef {object} NeedBuildContext
  * @property {Compilation} compilation
  * @property {FileSystemInfo} fileSystemInfo
  * @property {Map<string, string | Set<string>>} valueCacheVersions
@@ -128,7 +130,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {KnownBuildInfo & Record<string, any>} BuildInfo */
 
 /**
- * @typedef {Object} FactoryMeta
+ * @typedef {object} FactoryMeta
  * @property {boolean=} sideEffectFree
  */
 
@@ -270,6 +272,9 @@ class Module extends DependenciesBlock {
 		).setProfile(this, value);
 	}
 
+	/**
+	 * @returns {number | null} the pre order index
+	 */
 	get index() {
 		return ModuleGraph.getModuleGraphForModule(
 			this,
@@ -278,6 +283,9 @@ class Module extends DependenciesBlock {
 		).getPreOrderIndex(this);
 	}
 
+	/**
+	 * @param {number} value the pre order index
+	 */
 	set index(value) {
 		ModuleGraph.getModuleGraphForModule(
 			this,
@@ -286,6 +294,9 @@ class Module extends DependenciesBlock {
 		).setPreOrderIndex(this, value);
 	}
 
+	/**
+	 * @returns {number | null} the post order index
+	 */
 	get index2() {
 		return ModuleGraph.getModuleGraphForModule(
 			this,
@@ -294,6 +305,9 @@ class Module extends DependenciesBlock {
 		).getPostOrderIndex(this);
 	}
 
+	/**
+	 * @param {number} value the post order index
+	 */
 	set index2(value) {
 		ModuleGraph.getModuleGraphForModule(
 			this,
@@ -302,6 +316,9 @@ class Module extends DependenciesBlock {
 		).setPostOrderIndex(this, value);
 	}
 
+	/**
+	 * @returns {number | null} the depth
+	 */
 	get depth() {
 		return ModuleGraph.getModuleGraphForModule(
 			this,
@@ -310,6 +327,9 @@ class Module extends DependenciesBlock {
 		).getDepth(this);
 	}
 
+	/**
+	 * @param {number} value the depth
+	 */
 	set depth(value) {
 		ModuleGraph.getModuleGraphForModule(
 			this,
@@ -318,6 +338,9 @@ class Module extends DependenciesBlock {
 		).setDepth(this, value);
 	}
 
+	/**
+	 * @returns {Module | null | undefined} issuer
+	 */
 	get issuer() {
 		return ModuleGraph.getModuleGraphForModule(
 			this,
@@ -326,6 +349,9 @@ class Module extends DependenciesBlock {
 		).getIssuer(this);
 	}
 
+	/**
+	 * @param {Module | null} value issuer
+	 */
 	set issuer(value) {
 		ModuleGraph.getModuleGraphForModule(
 			this,
@@ -872,6 +898,7 @@ class Module extends DependenciesBlock {
 			codeGenerationResults: undefined
 		};
 		const sources = this.codeGeneration(codeGenContext).sources;
+
 		return type ? sources.get(type) : sources.get(first(this.getSourceTypes()));
 	}
 

package/lib/ModuleFactory.js

@@ -10,7 +10,7 @@
 /** @typedef {import("./Module")} Module */
 
 /**
- * @typedef {Object} ModuleFactoryResult
+ * @typedef {object} ModuleFactoryResult
  * @property {Module=} module the created module or unset if no module was created
  * @property {Set<string>=} fileDependencies
  * @property {Set<string>=} contextDependencies
@@ -19,14 +19,14 @@
  */
 
 /**
- * @typedef {Object} ModuleFactoryCreateDataContextInfo
+ * @typedef {object} ModuleFactoryCreateDataContextInfo
  * @property {string} issuer
  * @property {string | null=} issuerLayer
  * @property {string} compiler
  */
 
 /**
- * @typedef {Object} ModuleFactoryCreateData
+ * @typedef {object} ModuleFactoryCreateData
  * @property {ModuleFactoryCreateDataContextInfo} contextInfo
  * @property {ResolveOptions=} resolveOptions
  * @property {string} context