webpack 5.90.2 → 5.90.3

package/lib/NormalModuleFactory.js

@@ -38,10 +38,17 @@ const {
 /** @typedef {import("../declarations/WebpackOptions").RuleSetRule} RuleSetRule */
 /** @typedef {import("./Generator")} Generator */
 /** @typedef {import("./ModuleFactory").ModuleFactoryCreateData} ModuleFactoryCreateData */
+/** @typedef {import("./ModuleFactory").ModuleFactoryCreateDataContextInfo} ModuleFactoryCreateDataContextInfo */
 /** @typedef {import("./ModuleFactory").ModuleFactoryResult} ModuleFactoryResult */
+/** @typedef {import("./NormalModule").GeneratorOptions} GeneratorOptions */
+/** @typedef {import("./NormalModule").LoaderItem} LoaderItem */
 /** @typedef {import("./NormalModule").NormalModuleCreateData} NormalModuleCreateData */
+/** @typedef {import("./NormalModule").ParserOptions} ParserOptions */
 /** @typedef {import("./Parser")} Parser */
 /** @typedef {import("./ResolverFactory")} ResolverFactory */
+/** @typedef {import("./ResolverFactory").ResolveContext} ResolveContext */
+/** @typedef {import("./ResolverFactory").ResolveRequest} ResolveRequest */
+/** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
 /** @typedef {import("./dependencies/ModuleDependency")} ModuleDependency */
 /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
 
@@ -67,27 +74,43 @@ const {
 /**
  * @typedef {Object} ResourceData
  * @property {string} resource
- * @property {string} path
- * @property {string} query
- * @property {string} fragment
+ * @property {string=} path
+ * @property {string=} query
+ * @property {string=} fragment
  * @property {string=} context
  */
 
 /** @typedef {ResourceData & { data: Record<string, any> }} ResourceDataWithData */
 
-/** @typedef {Object} ParsedLoaderRequest
+/**
+ * @typedef {Object} ParsedLoaderRequest
  * @property {string} loader loader
  * @property {string|undefined} options options
  */
 
+/**
+ * @template T
+ * @callback Callback
+ * @param {(Error | null)=} err
+ * @param {T=} stats
+ * @returns {void}
+ */
+
 const EMPTY_RESOLVE_OPTIONS = {};
+/** @type {ParserOptions} */
 const EMPTY_PARSER_OPTIONS = {};
+/** @type {GeneratorOptions} */
 const EMPTY_GENERATOR_OPTIONS = {};
+/** @type {ParsedLoaderRequest[]} */
 const EMPTY_ELEMENTS = [];
 
 const MATCH_RESOURCE_REGEX = /^([^!]+)!=!/;
 const LEADING_DOT_EXTENSION_REGEX = /^[^.]/;
 
+/**
+ * @param {LoaderItem} data data
+ * @returns {string} ident
+ */
 const loaderToIdent = data => {
 	if (!data.options) {
 		return data.loader;
@@ -104,6 +127,11 @@ const loaderToIdent = data => {
 	return data.loader + "?" + JSON.stringify(data.options);
 };
 
+/**
+ * @param {LoaderItem[]} loaders loaders
+ * @param {string} resource resource
+ * @returns {string} stringified loaders and resource
+ */
 const stringifyLoadersAndResource = (loaders, resource) => {
 	let str = "";
 	for (const loader of loaders) {
@@ -112,6 +140,11 @@ const stringifyLoadersAndResource = (loaders, resource) => {
 	return str + resource;
 };
 
+/**
+ * @param {number} times times
+ * @param {(err?: null | Error) => void} callback callback
+ * @returns {(err?: null | Error) => void} callback
+ */
 const needCalls = (times, callback) => {
 	return err => {
 		if (--times === 0) {
@@ -124,6 +157,14 @@ const needCalls = (times, callback) => {
 	};
 };
 
+/**
+ * @template T
+ * @template O
+ * @param {T} globalOptions global options
+ * @param {string} type type
+ * @param {O} localOptions local options
+ * @returns {T & O | T | O} result
+ */
 const mergeGlobalOptions = (globalOptions, type, localOptions) => {
 	const parts = type.split("/");
 	let result;
@@ -147,11 +188,22 @@ const mergeGlobalOptions = (globalOptions, type, localOptions) => {
 };
 
 // TODO webpack 6 remove
+/**
+ * @param {string} name name
+ * @param {TODO} hook hook
+ * @returns {string} result
+ */
 const deprecationChangedHookMessage = (name, hook) => {
 	const names = hook.taps
-		.map(tapped => {
-			return tapped.name;
-		})
+		.map(
+			/**
+			 * @param {TODO} tapped tapped
+			 * @returns {string} name
+			 */
+			tapped => {
+				return tapped.name;
+			}
+		)
 		.join(", ");
 
 	return (
@@ -226,14 +278,19 @@ class NormalModuleFactory extends ModuleFactory {
 			createModule: new AsyncSeriesBailHook(["createData", "resolveData"]),
 			/** @type {SyncWaterfallHook<[Module, ResolveData["createData"], ResolveData], Module>} */
 			module: new SyncWaterfallHook(["module", "createData", "resolveData"]),
+			/** @type {HookMap<SyncBailHook<[ParserOptions], Parser>>} */
 			createParser: new HookMap(() => new SyncBailHook(["parserOptions"])),
+			/** @type {HookMap<SyncBailHook<[TODO, ParserOptions], void>>} */
 			parser: new HookMap(() => new SyncHook(["parser", "parserOptions"])),
+			/** @type {HookMap<SyncBailHook<[GeneratorOptions], Generator>>} */
 			createGenerator: new HookMap(
 				() => new SyncBailHook(["generatorOptions"])
 			),
+			/** @type {HookMap<SyncBailHook<[TODO, GeneratorOptions], void>>} */
 			generator: new HookMap(
 				() => new SyncHook(["generator", "generatorOptions"])
 			),
+			/** @type {HookMap<SyncBailHook<[TODO, ResolveData], Module>>} */
 			createModuleClass: new HookMap(
 				() => new SyncBailHook(["createData", "resolveData"])
 			)
@@ -251,7 +308,7 @@ class NormalModuleFactory extends ModuleFactory {
 		this.fs = fs;
 		this._globalParserOptions = options.parser;
 		this._globalGeneratorOptions = options.generator;
-		/** @type {Map<string, WeakMap<Object, TODO>>} */
+		/** @type {Map<string, WeakMap<Object, Parser>>} */
 		this.parserCache = new Map();
 		/** @type {Map<string, WeakMap<Object, Generator>>} */
 		this.generatorCache = new Map();
@@ -313,7 +370,9 @@ class NormalModuleFactory extends ModuleFactory {
 
 									// TODO webpack 6 make it required and move javascript/wasm/asset properties to own module
 									createdModule = this.hooks.createModuleClass
-										.for(createData.settings.type)
+										.for(
+											/** @type {ModuleSettings} */ (createData.settings).type
+										)
 										.call(createData, resolveData);
 
 									if (!createdModule) {
@@ -415,7 +474,7 @@ class NormalModuleFactory extends ModuleFactory {
 										: 0
 							)
 							.split(/!+/);
-						unresolvedResource = rawElements.pop();
+						unresolvedResource = /** @type {string} */ (rawElements.pop());
 						elements = rawElements.map(el => {
 							const { path, query } = cachedParseResourceWithoutFragment(el);
 							return {
@@ -433,6 +492,7 @@ class NormalModuleFactory extends ModuleFactory {
 					elements = EMPTY_ELEMENTS;
 				}
 
+				/** @type {ResolveContext} */
 				const resolveContext = {
 					fileDependencies,
 					missingDependencies,
@@ -442,6 +502,7 @@ class NormalModuleFactory extends ModuleFactory {
 				/** @type {ResourceDataWithData} */
 				let resourceData;
 
+				/** @type {undefined | LoaderItem[]} */
 				let loaders;
 
 				const continueCallback = needCalls(2, err => {
@@ -449,7 +510,7 @@ class NormalModuleFactory extends ModuleFactory {
 
 					// translate option idents
 					try {
-						for (const item of loaders) {
+						for (const item of /** @type {LoaderItem[]} */ (loaders)) {
 							if (typeof item.options === "string" && item.options[0] === "?") {
 								const ident = item.options.slice(1);
 								if (ident === "[[missing ident]]") {
@@ -469,7 +530,7 @@ class NormalModuleFactory extends ModuleFactory {
 							}
 						}
 					} catch (e) {
-						return callback(e);
+						return callback(/** @type {Error} */ (e));
 					}
 
 					if (!resourceData) {
@@ -481,8 +542,12 @@ class NormalModuleFactory extends ModuleFactory {
 						(matchResourceData !== undefined
 							? `${matchResourceData.resource}!=!`
 							: "") +
-						stringifyLoadersAndResource(loaders, resourceData.resource);
+						stringifyLoadersAndResource(
+							/** @type {LoaderItem[]} */ (loaders),
+							resourceData.resource
+						);
 
+					/** @type {ModuleSettings} */
 					const settings = {};
 					const useLoadersPost = [];
 					const useLoaders = [];
@@ -553,22 +618,32 @@ class NormalModuleFactory extends ModuleFactory {
 						}
 					}
 
-					let postLoaders, normalLoaders, preLoaders;
+					/** @type {undefined | LoaderItem[]} */
+					let postLoaders;
+					/** @type {undefined | LoaderItem[]} */
+					let normalLoaders;
+					/** @type {undefined | LoaderItem[]} */
+					let preLoaders;
 
 					const continueCallback = needCalls(3, err => {
 						if (err) {
 							return callback(err);
 						}
-						const allLoaders = postLoaders;
+						const allLoaders = /** @type {LoaderItem[]} */ (postLoaders);
 						if (matchResourceData === undefined) {
-							for (const loader of loaders) allLoaders.push(loader);
-							for (const loader of normalLoaders) allLoaders.push(loader);
+							for (const loader of /** @type {LoaderItem[]} */ (loaders))
+								allLoaders.push(loader);
+							for (const loader of /** @type {LoaderItem[]} */ (normalLoaders))
+								allLoaders.push(loader);
 						} else {
-							for (const loader of normalLoaders) allLoaders.push(loader);
-							for (const loader of loaders) allLoaders.push(loader);
+							for (const loader of /** @type {LoaderItem[]} */ (normalLoaders))
+								allLoaders.push(loader);
+							for (const loader of /** @type {LoaderItem[]} */ (loaders))
+								allLoaders.push(loader);
 						}
-						for (const loader of preLoaders) allLoaders.push(loader);
-						let type = settings.type;
+						for (const loader of /** @type {LoaderItem[]} */ (preLoaders))
+							allLoaders.push(loader);
+						let type = /** @type {string} */ (settings.type);
 						const resolveOptions = settings.resolve;
 						const layer = settings.layer;
 						if (layer !== undefined && !layers) {
@@ -605,7 +680,7 @@ class NormalModuleFactory extends ModuleFactory {
 								resolveOptions
 							});
 						} catch (e) {
-							return callback(e);
+							return callback(/** @type {Error} */ (e));
 						}
 						callback();
 					});
@@ -647,7 +722,7 @@ class NormalModuleFactory extends ModuleFactory {
 				this.resolveRequestArray(
 					contextInfo,
 					contextScheme ? this.context : context,
-					elements,
+					/** @type {LoaderItem[]} */ (elements),
 					loaderResolver,
 					resolveContext,
 					(err, result) => {
@@ -657,6 +732,9 @@ class NormalModuleFactory extends ModuleFactory {
 					}
 				);
 
+				/**
+				 * @param {string} context context
+				 */
 				const defaultResolve = context => {
 					if (/^($|\?)/.test(unresolvedResource)) {
 						resourceData = {
@@ -835,6 +913,14 @@ class NormalModuleFactory extends ModuleFactory {
 		});
 	}
 
+	/**
+	 * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
+	 * @param {string} context context
+	 * @param {string} unresolvedResource unresolved resource
+	 * @param {ResolverWithOptions} resolver resolver
+	 * @param {ResolveContext} resolveContext resolver context
+	 * @param {(err: null | Error, res?: string | false, req?: ResolveRequest) => void} callback callback
+	 */
 	resolveResource(
 		contextInfo,
 		context,
@@ -899,6 +985,16 @@ ${hints.join("\n\n")}`;
 		);
 	}
 
+	/**
+	 * @param {Error} error error
+	 * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
+	 * @param {string} context context
+	 * @param {string} unresolvedResource unresolved resource
+	 * @param {ResolverWithOptions} resolver resolver
+	 * @param {ResolveContext} resolveContext resolver context
+	 * @param {Callback<string[]>} callback callback
+	 * @private
+	 */
 	_resolveResourceErrorHints(
 		error,
 		contextInfo,
@@ -1010,11 +1106,20 @@ If changing the source code is not an option there is also a resolve options cal
 			],
 			(err, hints) => {
 				if (err) return callback(err);
-				callback(null, hints.filter(Boolean));
+				callback(null, /** @type {string[]} */ (hints).filter(Boolean));
 			}
 		);
 	}
 
+	/**
+	 * @param {ModuleFactoryCreateDataContextInfo} contextInfo context info
+	 * @param {string} context context
+	 * @param {LoaderItem[]} array array
+	 * @param {ResolverWithOptions} resolver resolver
+	 * @param {ResolveContext} resolveContext resolve context
+	 * @param {Callback<LoaderItem[]>} callback callback
+	 * @returns {void} result
+	 */
 	resolveRequestArray(
 		contextInfo,
 		context,
@@ -1023,6 +1128,7 @@ If changing the source code is not an option there is also a resolve options cal
 		resolveContext,
 		callback
 	) {
+		// LoaderItem
 		if (array.length === 0) return callback(null, array);
 		asyncLib.map(
 			array,
@@ -1064,10 +1170,11 @@ If changing the source code is not an option there is also a resolve options cal
 							? "module"
 							: /\.cjs$/i.test(parsedResult.path)
 								? "commonjs"
-								: resolveRequest.descriptionFileData === undefined
+								: /** @type {ResolveRequest} */
+									(resolveRequest).descriptionFileData === undefined
 									? undefined
-									: resolveRequest.descriptionFileData.type;
-
+									: /** @type {ResolveRequest} */
+										(resolveRequest).descriptionFileData.type;
 						const resolved = {
 							loader: parsedResult.path,
 							type,
@@ -1077,16 +1184,25 @@ If changing the source code is not an option there is also a resolve options cal
 										? parsedResult.query.slice(1)
 										: undefined
 									: item.options,
-							ident: item.options === undefined ? undefined : item.ident
+							ident:
+								item.options === undefined
+									? undefined
+									: /** @type {string} */ (item.ident)
 						};
-						return callback(null, resolved);
+
+						return callback(null, /** @type {LoaderItem} */ (resolved));
 					}
 				);
 			},
-			callback
+			/** @type {Callback<TODO>} */ (callback)
 		);
 	}
 
+	/**
+	 * @param {string} type type
+	 * @param {ParserOptions} parserOptions parser options
+	 * @returns {Parser} parser
+	 */
 	getParser(type, parserOptions = EMPTY_PARSER_OPTIONS) {
 		let cache = this.parserCache.get(type);
 
@@ -1107,7 +1223,7 @@ If changing the source code is not an option there is also a resolve options cal
 
 	/**
 	 * @param {string} type type
-	 * @param {{[k: string]: any}} parserOptions parser options
+	 * @param {ParserOptions} parserOptions parser options
 	 * @returns {Parser} parser
 	 */
 	createParser(type, parserOptions = {}) {
@@ -1124,6 +1240,11 @@ If changing the source code is not an option there is also a resolve options cal
 		return parser;
 	}
 
+	/**
+	 * @param {string} type type of generator
+	 * @param {GeneratorOptions} generatorOptions generator options
+	 * @returns {Generator} generator
+	 */
 	getGenerator(type, generatorOptions = EMPTY_GENERATOR_OPTIONS) {
 		let cache = this.generatorCache.get(type);
 
@@ -1142,6 +1263,11 @@ If changing the source code is not an option there is also a resolve options cal
 		return generator;
 	}
 
+	/**
+	 * @param {string} type type of generator
+	 * @param {GeneratorOptions} generatorOptions generator options
+	 * @returns {Generator} generator
+	 */
 	createGenerator(type, generatorOptions = {}) {
 		generatorOptions = mergeGlobalOptions(
 			this._globalGeneratorOptions,
@@ -1158,6 +1284,11 @@ If changing the source code is not an option there is also a resolve options cal
 		return generator;
 	}
 
+	/**
+	 * @param {Parameters<ResolverFactory["get"]>[0]} type type of resolver
+	 * @param {Parameters<ResolverFactory["get"]>[1]=} resolveOptions options
+	 * @returns {ReturnType<ResolverFactory["get"]>} the resolver
+	 */
 	getResolver(type, resolveOptions) {
 		return this.resolverFactory.get(type, resolveOptions);
 	}

package/lib/RawModule.js

@@ -19,6 +19,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./Module").CodeGenerationContext} CodeGenerationContext */
 /** @typedef {import("./Module").CodeGenerationResult} CodeGenerationResult */
 /** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
+/** @typedef {import("./Module").SourceTypes} SourceTypes */
 /** @typedef {import("./RequestShortener")} RequestShortener */
 /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
@@ -46,7 +47,7 @@ class RawModule extends Module {
 	}
 
 	/**
-	 * @returns {Set<string>} types available (do not mutate)
+	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
 		return TYPES;

package/lib/ResolverFactory.js

@@ -13,7 +13,9 @@ const {
 	resolveByProperty
 } = require("./util/cleverMerge");
 
+/** @typedef {import("enhanced-resolve").ResolveContext} ResolveContext */
 /** @typedef {import("enhanced-resolve").ResolveOptions} ResolveOptions */
+/** @typedef {import("enhanced-resolve").ResolveRequest} ResolveRequest */
 /** @typedef {import("enhanced-resolve").Resolver} Resolver */
 /** @typedef {import("../declarations/WebpackOptions").ResolveOptions} WebpackResolveOptions */
 /** @typedef {import("../declarations/WebpackOptions").ResolvePluginInstance} ResolvePluginInstance */

package/lib/RuntimeModule.js

@@ -19,6 +19,7 @@ const { WEBPACK_MODULE_TYPE_RUNTIME } = require("./ModuleTypeConstants");
 /** @typedef {import("./Module").CodeGenerationContext} CodeGenerationContext */
 /** @typedef {import("./Module").CodeGenerationResult} CodeGenerationResult */
 /** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
+/** @typedef {import("./Module").SourceTypes} SourceTypes */
 /** @typedef {import("./RequestShortener")} RequestShortener */
 /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
 /** @typedef {import("./WebpackError")} WebpackError */
@@ -123,7 +124,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
-	 * @returns {Set<string>} types available (do not mutate)
+	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
 		return TYPES;

package/lib/Stats.js

@@ -50,7 +50,7 @@ class Stats {
 	}
 
 	/**
-	 * @param {(string|StatsOptions)=} options stats options
+	 * @param {(string | boolean | StatsOptions)=} options stats options
 	 * @returns {StatsCompilation} json output
 	 */
 	toJson(options) {
@@ -66,7 +66,7 @@ class Stats {
 	}
 
 	/**
-	 * @param {(string|StatsOptions)=} options stats options
+	 * @param {(string | boolean | StatsOptions)=} options stats options
 	 * @returns {string} string output
 	 */
 	toString(options) {

package/lib/asset/RawDataUrlModule.js

@@ -17,6 +17,7 @@ const makeSerializable = require("../util/makeSerializable");
 /** @typedef {import("../Module").CodeGenerationContext} CodeGenerationContext */
 /** @typedef {import("../Module").CodeGenerationResult} CodeGenerationResult */
 /** @typedef {import("../Module").NeedBuildContext} NeedBuildContext */
+/** @typedef {import("../Module").SourceTypes} SourceTypes */
 /** @typedef {import("../RequestShortener")} RequestShortener */
 /** @typedef {import("../ResolverFactory").ResolverWithOptions} ResolverWithOptions */
 /** @typedef {import("../WebpackError")} WebpackError */
@@ -42,7 +43,7 @@ class RawDataUrlModule extends Module {
 	}
 
 	/**
-	 * @returns {Set<string>} types available (do not mutate)
+	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
 		return TYPES;