webpack 5.90.3 → 5.92.0

package/lib/FileSystemInfo.js

@@ -46,19 +46,19 @@ const RBDT_FILE_DEPENDENCIES = 9;
 const INVALID = Symbol("invalid");
 
 /**
- * @typedef {Object} FileSystemInfoEntry
+ * @typedef {object} FileSystemInfoEntry
  * @property {number} safeTime
  * @property {number=} timestamp
  */
 
 /**
- * @typedef {Object} ResolvedContextFileSystemInfoEntry
+ * @typedef {object} ResolvedContextFileSystemInfoEntry
  * @property {number} safeTime
  * @property {string=} timestampHash
  */
 
 /**
- * @typedef {Object} ContextFileSystemInfoEntry
+ * @typedef {object} ContextFileSystemInfoEntry
  * @property {number} safeTime
  * @property {string=} timestampHash
  * @property {ResolvedContextFileSystemInfoEntry=} resolved
@@ -66,21 +66,21 @@ const INVALID = Symbol("invalid");
  */
 
 /**
- * @typedef {Object} TimestampAndHash
+ * @typedef {object} TimestampAndHash
  * @property {number} safeTime
  * @property {number=} timestamp
  * @property {string} hash
  */
 
 /**
- * @typedef {Object} ResolvedContextTimestampAndHash
+ * @typedef {object} ResolvedContextTimestampAndHash
  * @property {number} safeTime
  * @property {string=} timestampHash
  * @property {string} hash
  */
 
 /**
- * @typedef {Object} ContextTimestampAndHash
+ * @typedef {object} ContextTimestampAndHash
  * @property {number} safeTime
  * @property {string=} timestampHash
  * @property {string} hash
@@ -89,14 +89,14 @@ const INVALID = Symbol("invalid");
  */
 
 /**
- * @typedef {Object} ContextHash
+ * @typedef {object} ContextHash
  * @property {string} hash
  * @property {string=} resolved
  * @property {Set<string>=} symlinks
  */
 
 /**
- * @typedef {Object} SnapshotOptimizationEntry
+ * @typedef {object} SnapshotOptimizationEntry
  * @property {Snapshot} snapshot
  * @property {number} shared
  * @property {Set<string> | undefined} snapshotContent
@@ -104,19 +104,19 @@ const INVALID = Symbol("invalid");
  */
 
 /**
- * @typedef {Object} ResolveBuildDependenciesResult
+ * @typedef {object} ResolveBuildDependenciesResult
  * @property {Set<string>} files list of files
  * @property {Set<string>} directories list of directories
  * @property {Set<string>} missing list of missing entries
  * @property {Map<string, string | false>} resolveResults stored resolve results
- * @property {Object} resolveDependencies dependencies of the resolving
+ * @property {object} resolveDependencies dependencies of the resolving
  * @property {Set<string>} resolveDependencies.files list of files
  * @property {Set<string>} resolveDependencies.directories list of directories
  * @property {Set<string>} resolveDependencies.missing list of missing entries
  */
 
 /**
- * @typedef {Object} SnapshotOptions
+ * @typedef {object} SnapshotOptions
  * @property {boolean=} hash should use hash to snapshot
  * @property {boolean=} timestamp should use timestamp to snapshot
  */
@@ -133,7 +133,13 @@ class SnapshotIterator {
 	}
 }
 
+/** @typedef {(snapshot: Snapshot) => (Map<string, any> | Set<string>)[]} GetMapsFunction */
+
 class SnapshotIterable {
+	/**
+	 * @param {Snapshot} snapshot snapshot
+	 * @param {GetMapsFunction} getMaps get maps function
+	 */
 	constructor(snapshot, getMaps) {
 		this.snapshot = snapshot;
 		this.getMaps = getMaps;
@@ -213,6 +219,13 @@ class SnapshotIterable {
 	}
 }
 
+/** @typedef {Map<string, FileSystemInfoEntry | null>} FileTimestamps */
+/** @typedef {Map<string, string | null>} FileHashes */
+/** @typedef {Map<string, TimestampAndHash | string | null>} FileTshs */
+/** @typedef {Map<string, ResolvedContextFileSystemInfoEntry | null>} ContextTimestamps */
+/** @typedef {Map<string, string | null>} ContextHashes */
+/** @typedef {Map<string, ResolvedContextTimestampAndHash | null>} ContextTshs */
+
 class Snapshot {
 	constructor() {
 		this._flags = 0;
@@ -224,17 +237,17 @@ class Snapshot {
 		this._cachedMissingIterable = undefined;
 		/** @type {number | undefined} */
 		this.startTime = undefined;
-		/** @type {Map<string, FileSystemInfoEntry | null> | undefined} */
+		/** @type {FileTimestamps | undefined} */
 		this.fileTimestamps = undefined;
-		/** @type {Map<string, string | null> | undefined} */
+		/** @type {FileHashes | undefined} */
 		this.fileHashes = undefined;
-		/** @type {Map<string, TimestampAndHash | string | null> | undefined} */
+		/** @type {FileTshs | undefined} */
 		this.fileTshs = undefined;
-		/** @type {Map<string, ResolvedContextFileSystemInfoEntry | null> | undefined} */
+		/** @type {ContextTimestamps | undefined} */
 		this.contextTimestamps = undefined;
-		/** @type {Map<string, string | null> | undefined} */
+		/** @type {ContextHashes | undefined} */
 		this.contextHashes = undefined;
-		/** @type {Map<string, ResolvedContextTimestampAndHash | null> | undefined} */
+		/** @type {ContextTshs | undefined} */
 		this.contextTshs = undefined;
 		/** @type {Map<string, boolean> | undefined} */
 		this.missingExistence = undefined;
@@ -254,6 +267,9 @@ class Snapshot {
 		return (this._flags & 1) !== 0;
 	}
 
+	/**
+	 * @param {number} value start value
+	 */
 	setStartTime(value) {
 		this._flags = this._flags | 1;
 		this.startTime = value;
@@ -427,7 +443,7 @@ class Snapshot {
 	}
 
 	/**
-	 * @param {function(Snapshot): (ReadonlyMap<string, any> | ReadonlySet<string>)[]} getMaps first
+	 * @param {GetMapsFunction} getMaps first
 	 * @returns {Iterable<string>} iterable
 	 */
 	_createIterable(getMaps) {
@@ -728,6 +744,10 @@ class SnapshotOptimization {
 	}
 }
 
+/**
+ * @param {string} str input
+ * @returns {TODO} result
+ */
 const parseString = str => {
 	if (str[0] === "'" || str[0] === "`")
 		str = `"${str.slice(1, -1).replace(/"/g, '\\"')}"`;
@@ -898,7 +918,7 @@ const addAll = (source, target) => {
 class FileSystemInfo {
 	/**
 	 * @param {InputFileSystem} fs file system
-	 * @param {Object} options options
+	 * @param {object} options options
 	 * @param {Iterable<string | RegExp>=} options.unmanagedPaths paths that are not managed by a package manager and the contents are subject to change
 	 * @param {Iterable<string | RegExp>=} options.managedPaths paths that are only managed by a package manager
 	 * @param {Iterable<string | RegExp>=} options.immutablePaths paths that are immutable
@@ -989,7 +1009,7 @@ class FileSystemInfo {
 		);
 		/** @type {StackedCacheMap<string, FileSystemInfoEntry | "ignore" | null>} */
 		this._fileTimestamps = new StackedCacheMap();
-		/** @type {Map<string, string>} */
+		/** @type {Map<string, string | null>} */
 		this._fileHashes = new Map();
 		/** @type {Map<string, TimestampAndHash | string>} */
 		this._fileTshs = new Map();
@@ -1081,13 +1101,18 @@ class FileSystemInfo {
 	}
 
 	logStatistics() {
+		const logger = /** @type {Logger} */ (this.logger);
+		/**
+		 * @param {string} header header
+		 * @param {string | undefined} message message
+		 */
 		const logWhenMessage = (header, message) => {
 			if (message) {
-				this.logger.log(`${header}: ${message}`);
+				logger.log(`${header}: ${message}`);
 			}
 		};
-		this.logger.log(`${this._statCreatedSnapshots} new snapshots created`);
-		this.logger.log(
+		logger.log(`${this._statCreatedSnapshots} new snapshots created`);
+		logger.log(
 			`${
 				this._statTestedSnapshotsNotCached &&
 				Math.round(
@@ -1099,7 +1124,7 @@ class FileSystemInfo {
 				this._statTestedSnapshotsCached + this._statTestedSnapshotsNotCached
 			})`
 		);
-		this.logger.log(
+		logger.log(
 			`${
 				this._statTestedChildrenNotCached &&
 				Math.round(
@@ -1110,8 +1135,8 @@ class FileSystemInfo {
 				this._statTestedChildrenCached + this._statTestedChildrenNotCached
 			})`
 		);
-		this.logger.log(`${this._statTestedEntries} entries tested`);
-		this.logger.log(
+		logger.log(`${this._statTestedEntries} entries tested`);
+		logger.log(
 			`File info in cache: ${this._fileTimestamps.size} timestamps ${this._fileHashes.size} hashes ${this._fileTshs.size} timestamp hash combinations`
 		);
 		logWhenMessage(
@@ -1126,7 +1151,7 @@ class FileSystemInfo {
 			`File timestamp hash combination snapshot optimization`,
 			this._fileTshsOptimization.getStatisticMessage()
 		);
-		this.logger.log(
+		logger.log(
 			`Directory info in cache: ${this._contextTimestamps.size} timestamps ${this._contextHashes.size} hashes ${this._contextTshs.size} timestamp hash combinations`
 		);
 		logWhenMessage(
@@ -1145,9 +1170,7 @@ class FileSystemInfo {
 			`Missing items snapshot optimization`,
 			this._missingExistenceOptimization.getStatisticMessage()
 		);
-		this.logger.log(
-			`Managed items info in cache: ${this._managedItems.size} items`
-		);
+		logger.log(`Managed items info in cache: ${this._managedItems.size} items`);
 		logWhenMessage(
 			`Managed items snapshot optimization`,
 			this._managedItemInfoOptimization.getStatisticMessage()
@@ -1302,13 +1325,15 @@ class FileSystemInfo {
 		const cache = this._contextHashes.get(path);
 		if (cache !== undefined) {
 			const resolved = getResolvedHash(cache);
-			if (resolved !== undefined) return callback(null, resolved);
+			if (resolved !== undefined)
+				return callback(null, /** @type {string} */ (resolved));
 			return this._resolveContextHash(cache, callback);
 		}
 		this.contextHashQueue.add(path, (err, entry) => {
 			if (err) return callback(err);
 			const resolved = getResolvedHash(entry);
-			if (resolved !== undefined) return callback(null, resolved);
+			if (resolved !== undefined)
+				return callback(null, /** @type {string} */ (resolved));
 			this._resolveContextHash(entry, callback);
 		});
 	}
@@ -1513,7 +1538,8 @@ class FileSystemInfo {
 								resolveResults.set(key, result.path);
 							} else {
 								invalidResolveResults.add(key);
-								this.logger.warn(
+								/** @type {Logger} */
+								(this.logger).warn(
 									`Resolving '${path}' in ${context} for build dependencies doesn't lead to expected result '${expected}', but to '${
 										err || (result && result.path)
 									}' instead. Resolving dependencies are ignored for this path.\n${pathToString(
@@ -1941,9 +1967,9 @@ class FileSystemInfo {
 	/**
 	 *
 	 * @param {number | null | undefined} startTime when processing the files has started
-	 * @param {Iterable<string>} files all files
-	 * @param {Iterable<string>} directories all directories
-	 * @param {Iterable<string>} missing all missing files or directories
+	 * @param {Iterable<string> | null} files all files
+	 * @param {Iterable<string> | null} directories all directories
+	 * @param {Iterable<string> | null} missing all missing files or directories
 	 * @param {SnapshotOptions | null | undefined} options options object (for future extensions)
 	 * @param {function((WebpackError | null)=, (Snapshot | null)=): void} callback callback function
 	 * @returns {void}
@@ -3018,7 +3044,7 @@ class FileSystemInfo {
 	/**
 	 * @template T
 	 * @template ItemType
-	 * @param {Object} options options
+	 * @param {object} options options
 	 * @param {string} options.path path
 	 * @param {function(string): ItemType} options.fromImmutablePath called when context item is an immutable path
 	 * @param {function(string): ItemType} options.fromManagedItem called when context item is a managed path
@@ -3318,7 +3344,7 @@ class FileSystemInfo {
 
 	/**
 	 * @param {ContextHash} entry context hash
-	 * @param {function((Error | null)=, string=): void} callback callback
+	 * @param {function((WebpackError | null)=, string=): void} callback callback
 	 * @returns {void}
 	 */
 	_resolveContextHash(entry, callback) {
@@ -3340,7 +3366,7 @@ class FileSystemInfo {
 				});
 			},
 			err => {
-				if (err) return callback(err);
+				if (err) return callback(/** @type {WebpackError} */ (err));
 				const hash = createHash(this._hashFunction);
 				hash.update(entry.hash);
 				hashes.sort();
@@ -3394,7 +3420,7 @@ class FileSystemInfo {
 							timestampHash: info,
 							hash: info || ""
 						}),
-						fromSymlink: (fle, target, callback) => {
+						fromSymlink: (file, target, callback) => {
 							callback(null, {
 								timestampHash: target,
 								hash: target,
@@ -3583,7 +3609,7 @@ class FileSystemInfo {
 								elements.length === 1 &&
 								elements[0] === "node_modules"
 							) {
-								// This is only a grouping folder e. g. used by yarn
+								// This is only a grouping folder e.g. used by yarn
 								// we are only interested in existence of this special directory
 								this._managedItems.set(path, "*nested");
 								return callback(null, "*nested");
@@ -3604,7 +3630,8 @@ class FileSystemInfo {
 					return callback(e);
 				}
 				if (!data.name) {
-					this.logger.warn(
+					/** @type {Logger} */
+					(this.logger).warn(
 						`${packageJsonPath} doesn't contain a "name" property (see snapshot.managedPaths option)`
 					);
 					return callback();

package/lib/FlagDependencyExportsPlugin.js

@@ -15,6 +15,7 @@ const Queue = require("./util/Queue");
 /** @typedef {import("./Dependency").ExportsSpec} ExportsSpec */
 /** @typedef {import("./ExportsInfo")} ExportsInfo */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./Module").BuildInfo} BuildInfo */
 
 const PLUGIN_NAME = "FlagDependencyExportsPlugin";
 const PLUGIN_LOGGER_NAME = `webpack.${PLUGIN_NAME}`;
@@ -63,7 +64,10 @@ class FlagDependencyExportsPlugin {
 								}
 							}
 							// If the module has no hash, it's uncacheable
-							if (typeof module.buildInfo.hash !== "string") {
+							if (
+								typeof (/** @type {BuildInfo} */ (module.buildInfo).hash) !==
+								"string"
+							) {
 								statFlaggedUncached++;
 								// Enqueue uncacheable module for determining the exports
 								queue.enqueue(module);
@@ -79,7 +83,8 @@ class FlagDependencyExportsPlugin {
 							}
 							cache.get(
 								module.identifier(),
-								module.buildInfo.hash,
+								/** @type {BuildInfo} */
+								(module.buildInfo).hash,
 								(err, result) => {
 									if (err) return callback(err);
 
@@ -234,7 +239,10 @@ class FlagDependencyExportsPlugin {
 											if (exports) {
 												const nestedExportsInfo =
 													exportInfo.createNestedExportsInfo();
-												mergeExports(nestedExportsInfo, exports);
+												mergeExports(
+													/** @type {ExportsInfo} */ (nestedExportsInfo),
+													exports
+												);
 											}
 
 											if (
@@ -272,7 +280,8 @@ class FlagDependencyExportsPlugin {
 
 											if (exportInfo.exportsInfoOwned) {
 												if (
-													exportInfo.exportsInfo.setRedirectNamedTo(
+													/** @type {ExportsInfo} */
+													(exportInfo.exportsInfo).setRedirectNamedTo(
 														targetExportsInfo
 													)
 												) {
@@ -312,7 +321,7 @@ class FlagDependencyExportsPlugin {
 
 							logger.time("figure out provided exports");
 							while (queue.length > 0) {
-								module = queue.dequeue();
+								module = /** @type {Module} */ (queue.dequeue());
 
 								statQueueItemsProcessed++;
 
@@ -356,7 +365,11 @@ class FlagDependencyExportsPlugin {
 							asyncLib.each(
 								modulesToStore,
 								(module, callback) => {
-									if (typeof module.buildInfo.hash !== "string") {
+									if (
+										typeof (
+											/** @type {BuildInfo} */ (module.buildInfo).hash
+										) !== "string"
+									) {
 										// not cacheable
 										return callback();
 									}
@@ -370,7 +383,8 @@ class FlagDependencyExportsPlugin {
 									}
 									cache.store(
 										module.identifier(),
-										module.buildInfo.hash,
+										/** @type {BuildInfo} */
+										(module.buildInfo).hash,
 										cachedData,
 										callback
 									);

package/lib/Generator.js

@@ -13,6 +13,7 @@
 /** @typedef {import("./DependencyTemplate")} DependencyTemplate */
 /** @typedef {import("./DependencyTemplates")} DependencyTemplates */
 /** @typedef {import("./Module").ConcatenationBailoutReasonContext} ConcatenationBailoutReasonContext */
+/** @typedef {import("./Module").RuntimeRequirements} RuntimeRequirements */
 /** @typedef {import("./ModuleGraph")} ModuleGraph */
 /** @typedef {import("./NormalModule")} NormalModule */
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
@@ -20,14 +21,13 @@
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
 /**
- * @typedef {Object} GenerateContext
+ * @typedef {object} GenerateContext
  * @property {DependencyTemplates} dependencyTemplates mapping from dependencies to templates
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
  * @property {ModuleGraph} moduleGraph the module graph
  * @property {ChunkGraph} chunkGraph the chunk graph
- * @property {Set<string>} runtimeRequirements the requirements for runtime
+ * @property {RuntimeRequirements} runtimeRequirements the requirements for runtime
  * @property {RuntimeSpec} runtime the runtime
- * @property {RuntimeSpec[]} [runtimes] the runtimes
  * @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 {string} type which kind of code should be generated
@@ -35,7 +35,7 @@
  */
 
 /**
- * @typedef {Object} UpdateHashContext
+ * @typedef {object} UpdateHashContext
  * @property {NormalModule} module the module
  * @property {ChunkGraph} chunkGraph
  * @property {RuntimeSpec} runtime

package/lib/HookWebpackError.js

@@ -12,7 +12,7 @@ const WebpackError = require("./WebpackError");
 /**
  * @template T
  * @callback Callback
- * @param {Error=} err
+ * @param {Error | null} err
  * @param {T=} stats
  * @returns {void}
  */
@@ -51,7 +51,7 @@ module.exports.makeWebpackError = makeWebpackError;
 
 /**
  * @template T
- * @param {function((WebpackError | null)=, T=): void} callback webpack error callback
+ * @param {function(WebpackError | null, T=): void} callback webpack error callback
  * @param {string} hook name of hook
  * @returns {Callback<T>} generic callback
  */