webpack 5.90.2 → 5.91.0

package/lib/RuntimeTemplate.js

@@ -13,13 +13,18 @@ const compileBooleanMatcher = require("./util/compileBooleanMatcher");
 const propertyAccess = require("./util/propertyAccess");
 const { forEachRuntime, subtractRuntime } = require("./util/runtime");
 
+/** @typedef {import("../declarations/WebpackOptions").Environment} Environment */
 /** @typedef {import("../declarations/WebpackOptions").OutputNormalized} OutputOptions */
 /** @typedef {import("./AsyncDependenciesBlock")} AsyncDependenciesBlock */
+/** @typedef {import("./Chunk")} Chunk */
 /** @typedef {import("./ChunkGraph")} ChunkGraph */
 /** @typedef {import("./CodeGenerationResults")} CodeGenerationResults */
+/** @typedef {import("./CodeGenerationResults").CodeGenerationResult} CodeGenerationResult */
 /** @typedef {import("./Compilation")} Compilation */
 /** @typedef {import("./Dependency")} Dependency */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./Module").BuildMeta} BuildMeta */
+/** @typedef {import("./Module").RuntimeRequirements} RuntimeRequirements */
 /** @typedef {import("./ModuleGraph")} ModuleGraph */
 /** @typedef {import("./RequestShortener")} RequestShortener */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
@@ -52,8 +57,8 @@ Module has these incoming connections: ${Array.from(
 };
 
 /**
- * @param {string|undefined} definition global object definition
- * @returns {string} save to use global object
+ * @param {string | undefined} definition global object definition
+ * @returns {string | undefined} save to use global object
  */
 function getGlobalObject(definition) {
 	if (!definition) return definition;
@@ -82,8 +87,13 @@ class RuntimeTemplate {
 		this.compilation = compilation;
 		this.outputOptions = outputOptions || {};
 		this.requestShortener = requestShortener;
-		this.globalObject = getGlobalObject(outputOptions.globalObject);
-		this.contentHashReplacement = "X".repeat(outputOptions.hashDigestLength);
+		this.globalObject =
+			/** @type {string} */
+			(getGlobalObject(outputOptions.globalObject));
+		this.contentHashReplacement = "X".repeat(
+			/** @type {NonNullable<OutputOptions["hashDigestLength"]>} */
+			(outputOptions.hashDigestLength)
+		);
 	}
 
 	isIIFE() {
@@ -95,51 +105,68 @@ class RuntimeTemplate {
 	}
 
 	supportsConst() {
-		return this.outputOptions.environment.const;
+		return /** @type {Environment} */ (this.outputOptions.environment).const;
 	}
 
 	supportsArrowFunction() {
-		return this.outputOptions.environment.arrowFunction;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.arrowFunction;
 	}
 
 	supportsAsyncFunction() {
-		return this.outputOptions.environment.asyncFunction;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.asyncFunction;
 	}
 
 	supportsOptionalChaining() {
-		return this.outputOptions.environment.optionalChaining;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.optionalChaining;
 	}
 
 	supportsForOf() {
-		return this.outputOptions.environment.forOf;
+		return /** @type {Environment} */ (this.outputOptions.environment).forOf;
 	}
 
 	supportsDestructuring() {
-		return this.outputOptions.environment.destructuring;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.destructuring;
 	}
 
 	supportsBigIntLiteral() {
-		return this.outputOptions.environment.bigIntLiteral;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.bigIntLiteral;
 	}
 
 	supportsDynamicImport() {
-		return this.outputOptions.environment.dynamicImport;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.dynamicImport;
 	}
 
 	supportsEcmaScriptModuleSyntax() {
-		return this.outputOptions.environment.module;
+		return /** @type {Environment} */ (this.outputOptions.environment).module;
 	}
 
 	supportTemplateLiteral() {
-		return this.outputOptions.environment.templateLiteral;
+		return /** @type {Environment} */ (this.outputOptions.environment)
+			.templateLiteral;
 	}
 
+	/**
+	 * @param {string} returnValue return value
+	 * @param {string} args arguments
+	 * @returns {string} returning function
+	 */
 	returningFunction(returnValue, args = "") {
 		return this.supportsArrowFunction()
 			? `(${args}) => (${returnValue})`
 			: `function(${args}) { return ${returnValue}; }`;
 	}
 
+	/**
+	 * @param {string} args arguments
+	 * @param {string | string[]} body body
+	 * @returns {string} basic function
+	 */
 	basicFunction(args, body) {
 		return this.supportsArrowFunction()
 			? `(${args}) => {\n${Template.indent(body)}\n}`
@@ -211,16 +238,29 @@ class RuntimeTemplate {
 			: str;
 	}
 
+	/**
+	 * @param {string} expression expression
+	 * @param {string} args arguments
+	 * @returns {string} expression function code
+	 */
 	expressionFunction(expression, args = "") {
 		return this.supportsArrowFunction()
 			? `(${args}) => (${expression})`
 			: `function(${args}) { ${expression}; }`;
 	}
 
+	/**
+	 * @returns {string} empty function code
+	 */
 	emptyFunction() {
 		return this.supportsArrowFunction() ? "x => {}" : "function() {}";
 	}
 
+	/**
+	 * @param {string[]} items items
+	 * @param {string} value value
+	 * @returns {string} destructure array code
+	 */
 	destructureArray(items, value) {
 		return this.supportsDestructuring()
 			? `var [${items.join(", ")}] = ${value};`
@@ -229,6 +269,11 @@ class RuntimeTemplate {
 				);
 	}
 
+	/**
+	 * @param {string[]} items items
+	 * @param {string} value value
+	 * @returns {string} destructure object code
+	 */
 	destructureObject(items, value) {
 		return this.supportsDestructuring()
 			? `var {${items.join(", ")}} = ${value};`
@@ -237,10 +282,21 @@ class RuntimeTemplate {
 				);
 	}
 
+	/**
+	 * @param {string} args arguments
+	 * @param {string} body body
+	 * @returns {string} IIFE code
+	 */
 	iife(args, body) {
 		return `(${this.basicFunction(args, body)})()`;
 	}
 
+	/**
+	 * @param {string} variable variable
+	 * @param {string} array array
+	 * @param {string | string[]} body body
+	 * @returns {string} for each code
+	 */
 	forEach(variable, array, body) {
 		return this.supportsForOf()
 			? `for(const ${variable} of ${array}) {\n${Template.indent(body)}\n}`
@@ -336,7 +392,7 @@ class RuntimeTemplate {
 	 * @param {Object} options options object
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
 	 * @param {Module} options.module the module
-	 * @param {string} options.request the request that should be printed as comment
+	 * @param {string=} options.request the request that should be printed as comment
 	 * @param {string=} options.idExpr expression to use as id expression
 	 * @param {"expression" | "promise" | "statements"} options.type which kind of code should be returned
 	 * @returns {string} the code
@@ -373,7 +429,7 @@ class RuntimeTemplate {
 	 * @param {Object} options options object
 	 * @param {Module} options.module the module
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
-	 * @param {string} options.request the request that should be printed as comment
+	 * @param {string=} options.request the request that should be printed as comment
 	 * @param {boolean=} options.weak if the dependency is weak (will create a nice error message)
 	 * @returns {string} the expression
 	 */
@@ -402,9 +458,9 @@ class RuntimeTemplate {
 	 * @param {Object} options options object
 	 * @param {Module | null} options.module the module
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
-	 * @param {string} options.request the request that should be printed as comment
+	 * @param {string=} options.request the request that should be printed as comment
 	 * @param {boolean=} options.weak if the dependency is weak (will create a nice error message)
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} the expression
 	 */
 	moduleRaw({ module, chunkGraph, request, weak, runtimeRequirements }) {
@@ -447,7 +503,7 @@ class RuntimeTemplate {
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
 	 * @param {string} options.request the request that should be printed as comment
 	 * @param {boolean=} options.weak if the dependency is weak (will create a nice error message)
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} the expression
 	 */
 	moduleExports({ module, chunkGraph, request, weak, runtimeRequirements }) {
@@ -467,7 +523,7 @@ class RuntimeTemplate {
 	 * @param {string} options.request the request that should be printed as comment
 	 * @param {boolean=} options.strict if the current module is in strict esm mode
 	 * @param {boolean=} options.weak if the dependency is weak (will create a nice error message)
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} the expression
 	 */
 	moduleNamespace({
@@ -538,7 +594,7 @@ class RuntimeTemplate {
 	 * @param {string} options.message a message for the comment
 	 * @param {boolean=} options.strict if the current module is in strict esm mode
 	 * @param {boolean=} options.weak if the dependency is weak (will create a nice error message)
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} the promise expression
 	 */
 	moduleNamespacePromise({
@@ -684,7 +740,7 @@ class RuntimeTemplate {
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
 	 * @param {RuntimeSpec=} options.runtime runtime for which this code will be generated
 	 * @param {RuntimeSpec | boolean=} options.runtimeCondition only execute the statement in some runtimes
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} expression
 	 */
 	runtimeConditionExpression({
@@ -698,12 +754,16 @@ class RuntimeTemplate {
 		/** @type {Set<string>} */
 		const positiveRuntimeIds = new Set();
 		forEachRuntime(runtimeCondition, runtime =>
-			positiveRuntimeIds.add(`${chunkGraph.getRuntimeId(runtime)}`)
+			positiveRuntimeIds.add(
+				`${chunkGraph.getRuntimeId(/** @type {string} */ (runtime))}`
+			)
 		);
 		/** @type {Set<string>} */
 		const negativeRuntimeIds = new Set();
 		forEachRuntime(subtractRuntime(runtime, runtimeCondition), runtime =>
-			negativeRuntimeIds.add(`${chunkGraph.getRuntimeId(runtime)}`)
+			negativeRuntimeIds.add(
+				`${chunkGraph.getRuntimeId(/** @type {string} */ (runtime))}`
+			)
 		);
 		runtimeRequirements.add(RuntimeGlobals.runtimeId);
 		return compileBooleanMatcher.fromLists(
@@ -722,7 +782,7 @@ class RuntimeTemplate {
 	 * @param {string} options.importVar name of the import variable
 	 * @param {Module} options.originModule module in which the statement is emitted
 	 * @param {boolean=} options.weak true, if this is a weak dependency
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {[string, string]} the import statement and the compat statement
 	 */
 	importStatement({
@@ -774,7 +834,8 @@ class RuntimeTemplate {
 
 		const exportsType = module.getExportsType(
 			chunkGraph.moduleGraph,
-			originModule.buildMeta.strictHarmonyModule
+			/** @type {BuildMeta} */
+			(originModule.buildMeta).strictHarmonyModule
 		);
 		runtimeRequirements.add(RuntimeGlobals.require);
 		const importContent = `/* harmony import */ ${optDeclaration}${importVar} = ${RuntimeGlobals.require}(${moduleId});\n`;
@@ -803,7 +864,7 @@ class RuntimeTemplate {
 	 * @param {string} options.importVar the identifier name of the import variable
 	 * @param {InitFragment<TODO>[]} options.initFragments init fragments will be added here
 	 * @param {RuntimeSpec} options.runtime runtime for which this code will be generated
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} expression
 	 */
 	exportFromImport({
@@ -831,7 +892,8 @@ class RuntimeTemplate {
 		}
 		const exportsType = module.getExportsType(
 			moduleGraph,
-			originModule.buildMeta.strictHarmonyModule
+			/** @type {BuildMeta} */
+			(originModule.buildMeta).strictHarmonyModule
 		);
 
 		if (defaultInterop) {
@@ -913,10 +975,10 @@ class RuntimeTemplate {
 
 	/**
 	 * @param {Object} options options
-	 * @param {AsyncDependenciesBlock} options.block the async block
+	 * @param {AsyncDependenciesBlock | undefined} options.block the async block
 	 * @param {string} options.message the message
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} expression
 	 */
 	blockPromise({ block, message, chunkGraph, runtimeRequirements }) {
@@ -962,6 +1024,10 @@ class RuntimeTemplate {
 				runtimeRequirements.add(RuntimeGlobals.hasFetchPriority);
 			}
 
+			/**
+			 * @param {Chunk} chunk chunk
+			 * @returns {string} require chunk id code
+			 */
 			const requireChunkId = chunk =>
 				`${RuntimeGlobals.ensureChunk}(${JSON.stringify(chunk.id)}${
 					fetchPriority ? `, ${JSON.stringify(fetchPriority)}` : ""
@@ -978,7 +1044,7 @@ class RuntimeTemplate {
 	 * @param {Object} options options
 	 * @param {AsyncDependenciesBlock} options.block the async block
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} expression
 	 */
@@ -1010,7 +1076,7 @@ class RuntimeTemplate {
 	 * @param {Object} options options
 	 * @param {Dependency} options.dependency the dependency
 	 * @param {ChunkGraph} options.chunkGraph the chunk graph
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @param {string=} options.request request string used originally
 	 * @returns {string} expression
 	 */
@@ -1030,7 +1096,7 @@ class RuntimeTemplate {
 	/**
 	 * @param {Object} options options
 	 * @param {string} options.exportsArgument the name of the exports object
-	 * @param {Set<string>} options.runtimeRequirements if set, will be filled with runtime requirements
+	 * @param {RuntimeRequirements} options.runtimeRequirements if set, will be filled with runtime requirements
 	 * @returns {string} statement
 	 */
 	defineEsModuleFlagStatement({ exportsArgument, runtimeRequirements }) {
@@ -1052,7 +1118,9 @@ class RuntimeTemplate {
 			return "data:,";
 		}
 		const codeGen = codeGenerationResults.get(module, runtime);
-		const { data } = codeGen;
+		const data = /** @type {NonNullable<CodeGenerationResult["data"]>} */ (
+			codeGen.data
+		);
 		const url = data.get("url");
 		if (url) return url.toString();
 		const filename = data.get("filename");

package/lib/SourceMapDevToolPlugin.js

@@ -29,6 +29,7 @@ const { makePathsAbsolute } = require("./util/identifier");
 /** @typedef {import("./Module")} Module */
 /** @typedef {import("./NormalModule").SourceMap} SourceMap */
 /** @typedef {import("./util/Hash")} Hash */
+/** @typedef {import("./util/fs").OutputFileSystem} OutputFileSystem */
 
 const validate = createSchemaValidation(
 	require("../schemas/plugins/SourceMapDevToolPlugin.check.js"),
@@ -165,7 +166,9 @@ class SourceMapDevToolPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		const outputFs = compiler.outputFileSystem;
+		const outputFs = /** @type {OutputFileSystem} */ (
+			compiler.outputFileSystem
+		);
 		const sourceMapFilename = this.sourceMapFilename;
 		const sourceMappingURLComment = this.sourceMappingURLComment;
 		const moduleFilenameTemplate = this.moduleFilenameTemplate;

package/lib/Stats.js

@@ -7,6 +7,7 @@
 
 /** @typedef {import("../declarations/WebpackOptions").StatsOptions} StatsOptions */
 /** @typedef {import("./Compilation")} Compilation */
+/** @typedef {import("./Compilation").NormalizedStatsOptions} NormalizedStatsOptions */
 /** @typedef {import("./stats/DefaultStatsFactoryPlugin").StatsCompilation} StatsCompilation */
 
 class Stats {
@@ -50,7 +51,7 @@ class Stats {
 	}
 
 	/**
-	 * @param {(string|StatsOptions)=} options stats options
+	 * @param {(string | boolean | StatsOptions)=} options stats options
 	 * @returns {StatsCompilation} json output
 	 */
 	toJson(options) {
@@ -58,7 +59,9 @@ class Stats {
 			forToString: false
 		});
 
-		const statsFactory = this.compilation.createStatsFactory(options);
+		const statsFactory = this.compilation.createStatsFactory(
+			/** @type {NormalizedStatsOptions} */ (options)
+		);
 
 		return statsFactory.create("compilation", this.compilation, {
 			compilation: this.compilation
@@ -66,7 +69,7 @@ class Stats {
 	}
 
 	/**
-	 * @param {(string|StatsOptions)=} options stats options
+	 * @param {(string | boolean | StatsOptions)=} options stats options
 	 * @returns {string} string output
 	 */
 	toString(options) {
@@ -74,8 +77,12 @@ class Stats {
 			forToString: true
 		});
 
-		const statsFactory = this.compilation.createStatsFactory(options);
-		const statsPrinter = this.compilation.createStatsPrinter(options);
+		const statsFactory = this.compilation.createStatsFactory(
+			/** @type {NormalizedStatsOptions} */ (options)
+		);
+		const statsPrinter = this.compilation.createStatsPrinter(
+			/** @type {NormalizedStatsOptions} */ (options)
+		);
 
 		const data = statsFactory.create("compilation", this.compilation, {
 			compilation: this.compilation

package/lib/TemplatedPathPlugin.js

@@ -12,19 +12,26 @@ const Chunk = require("./Chunk");
 const Module = require("./Module");
 const { parseResource } = require("./util/identifier");
 
+/** @typedef {import("./ChunkGraph")} ChunkGraph */
 /** @typedef {import("./Compilation").AssetInfo} AssetInfo */
 /** @typedef {import("./Compilation").PathData} PathData */
 /** @typedef {import("./Compiler")} Compiler */
 
 const REGEXP = /\[\\*([\w:]+)\\*\]/gi;
 
+/**
+ * @param {string | number} id id
+ * @returns {string | number} result
+ */
 const prepareId = id => {
 	if (typeof id !== "string") return id;
 
 	if (/^"\s\+*.*\+\s*"$/.test(id)) {
 		const match = /^"\s\+*\s*(.*)\s*\+\s*"$/.exec(id);
 
-		return `" + (${match[1]} + "").replace(/(^[.-]|[^a-zA-Z0-9_-])+/g, "_") + "`;
+		return `" + (${
+			/** @type {string[]} */ (match)[1]
+		} + "").replace(/(^[.-]|[^a-zA-Z0-9_-])+/g, "_") + "`;
 	}
 
 	return id.replace(/(^[.-]|[^a-zA-Z0-9_-])+/g, "_");
@@ -58,7 +65,15 @@ const hashLength = (replacer, handler, assetInfo, hashName) => {
 	return fn;
 };
 
+/** @typedef {(match: string, arg?: string, input?: string) => string} Replacer */
+
+/**
+ * @param {string | number | null | undefined | (() => string | number | null | undefined)} value value
+ * @param {boolean=} allowEmpty allow empty
+ * @returns {Replacer} replacer
+ */
 const replacer = (value, allowEmpty) => {
+	/** @type {Replacer} */
 	const fn = (match, arg, input) => {
 		if (typeof value === "function") {
 			value = value();
@@ -81,6 +96,12 @@ const replacer = (value, allowEmpty) => {
 
 const deprecationCache = new Map();
 const deprecatedFunction = (() => () => {})();
+/**
+ * @param {Function} fn function
+ * @param {string} message message
+ * @param {string} code code
+ * @returns {function(...any[]): void} function with deprecation output
+ */
 const deprecated = (fn, message, code) => {
 	let d = deprecationCache.get(message);
 	if (d === undefined) {
@@ -227,7 +248,7 @@ const replacePathVariables = (path, data, assetInfo) => {
 			),
 			data.contentHashWithLength ||
 				("contentHashWithLength" in chunk && chunk.contentHashWithLength
-					? chunk.contentHashWithLength[contentHashType]
+					? chunk.contentHashWithLength[/** @type {string} */ (contentHashType)]
 					: undefined),
 			assetInfo,
 			"contenthash"
@@ -255,13 +276,18 @@ const replacePathVariables = (path, data, assetInfo) => {
 
 		const idReplacer = replacer(() =>
 			prepareId(
-				module instanceof Module ? chunkGraph.getModuleId(module) : module.id
+				module instanceof Module
+					? /** @type {ChunkGraph} */ (chunkGraph).getModuleId(module)
+					: module.id
 			)
 		);
 		const moduleHashReplacer = hashLength(
 			replacer(() =>
 				module instanceof Module
-					? chunkGraph.getRenderedModuleHash(module, data.runtime)
+					? /** @type {ChunkGraph} */ (chunkGraph).getRenderedModuleHash(
+							module,
+							data.runtime
+						)
 					: module.hash
 			),
 			"hashWithLength" in module ? module.hashWithLength : undefined,
@@ -269,7 +295,7 @@ const replacePathVariables = (path, data, assetInfo) => {
 			"modulehash"
 		);
 		const contentHashReplacer = hashLength(
-			replacer(data.contentHash),
+			replacer(/** @type {string} */ (data.contentHash)),
 			undefined,
 			assetInfo,
 			"contenthash"
@@ -300,7 +326,7 @@ const replacePathVariables = (path, data, assetInfo) => {
 	if (typeof data.runtime === "string") {
 		replacements.set(
 			"runtime",
-			replacer(() => prepareId(data.runtime))
+			replacer(() => prepareId(/** @type {string} */ (data.runtime)))
 		);
 	} else {
 		replacements.set("runtime", replacer("_"));