webpack 5.86.0 → 5.88.0

package/lib/DelegatedModuleFactoryPlugin.js

@@ -7,6 +7,8 @@
 
 const DelegatedModule = require("./DelegatedModule");
 
+/** @typedef {import("./NormalModuleFactory")} NormalModuleFactory */
+
 // options.source
 // options.type
 // options.context
@@ -20,6 +22,10 @@ class DelegatedModuleFactoryPlugin {
 		options.extensions = options.extensions || ["", ".js", ".json", ".wasm"];
 	}
 
+	/**
+	 * @param {NormalModuleFactory} normalModuleFactory the normal module factory
+	 * @returns {void}
+	 */
 	apply(normalModuleFactory) {
 		const scope = this.options.scope;
 		if (scope) {

package/lib/Dependency.js

@@ -89,9 +89,9 @@ const getIgnoredModule = memoize(() => {
 
 class Dependency {
 	constructor() {
-		/** @type {Module} */
+		/** @type {Module | undefined} */
 		this._parentModule = undefined;
-		/** @type {DependenciesBlock} */
+		/** @type {DependenciesBlock | undefined} */
 		this._parentDependenciesBlock = undefined;
 		/** @type {number} */
 		this._parentDependenciesBlockIndex = -1;
@@ -174,6 +174,12 @@ class Dependency {
 		this._loc = loc;
 	}
 
+	/**
+	 * @param {number} startLine start line
+	 * @param {number} startColumn start column
+	 * @param {number} endLine end line
+	 * @param {number} endColumn end column
+	 */
 	setLoc(startLine, startColumn, endLine, endColumn) {
 		this._locSL = startLine;
 		this._locSC = startColumn;
@@ -247,7 +253,7 @@ class Dependency {
 	/**
 	 * Returns warnings
 	 * @param {ModuleGraph} moduleGraph module graph
-	 * @returns {WebpackError[]} warnings
+	 * @returns {WebpackError[] | null | undefined} warnings
 	 */
 	getWarnings(moduleGraph) {
 		return null;
@@ -256,7 +262,7 @@ class Dependency {
 	/**
 	 * Returns errors
 	 * @param {ModuleGraph} moduleGraph module graph
-	 * @returns {WebpackError[]} errors
+	 * @returns {WebpackError[] | null | undefined} errors
 	 */
 	getErrors(moduleGraph) {
 		return null;
@@ -288,7 +294,7 @@ class Dependency {
 
 	/**
 	 * @param {string} context context directory
-	 * @returns {Module} a module
+	 * @returns {Module | null} a module
 	 */
 	createIgnoredModule(context) {
 		return getIgnoredModule();

package/lib/DllEntryPlugin.js

@@ -9,6 +9,8 @@ const DllModuleFactory = require("./DllModuleFactory");
 const DllEntryDependency = require("./dependencies/DllEntryDependency");
 const EntryDependency = require("./dependencies/EntryDependency");
 
+/** @typedef {import("./Compiler")} Compiler */
+
 class DllEntryPlugin {
 	/**
 	 * @param {string} context context
@@ -21,6 +23,11 @@ class DllEntryPlugin {
 		this.options = options;
 	}
 
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
 			"DllEntryPlugin",
@@ -51,7 +58,10 @@ class DllEntryPlugin {
 					this.options.name
 				),
 				this.options,
-				callback
+				error => {
+					if (error) return callback(error);
+					callback();
+				}
 			);
 		});
 	}

package/lib/DllReferencePlugin.js

@@ -16,6 +16,7 @@ const makePathsRelative = require("./util/identifier").makePathsRelative;
 /** @typedef {import("../declarations/WebpackOptions").Externals} Externals */
 /** @typedef {import("../declarations/plugins/DllReferencePlugin").DllReferencePluginOptions} DllReferencePluginOptions */
 /** @typedef {import("../declarations/plugins/DllReferencePlugin").DllReferencePluginOptionsManifest} DllReferencePluginOptionsManifest */
+/** @typedef {import("./Compiler")} Compiler */
 
 const validate = createSchemaValidation(
 	require("../schemas/plugins/DllReferencePlugin.check.js"),
@@ -37,6 +38,11 @@ class DllReferencePlugin {
 		this._compilationData = new WeakMap();
 	}
 
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
 			"DllReferencePlugin",
@@ -140,7 +146,9 @@ class DllReferencePlugin {
 						// If there was an error parsing the manifest file, add the
 						// error as a compilation error to make the compilation fail.
 						if (data.error) {
-							compilation.errors.push(data.error);
+							compilation.errors.push(
+								/** @type {DllManifestError} */ (data.error)
+							);
 						}
 						compilation.fileDependencies.add(manifest);
 					}
@@ -151,6 +159,10 @@ class DllReferencePlugin {
 }
 
 class DllManifestError extends WebpackError {
+	/**
+	 * @param {string} filename filename of the manifest
+	 * @param {string} message error message
+	 */
 	constructor(filename, message) {
 		super();
 

package/lib/Entrypoint.js

@@ -83,7 +83,7 @@ class Entrypoint extends ChunkGroup {
 	 * @returns {Chunk} chunk
 	 */
 	getEntrypointChunk() {
-		return this._entrypointChunk;
+		return /** @type {Chunk} */ (this._entrypointChunk);
 	}
 
 	/**

package/lib/ErrorHelpers.js

@@ -45,6 +45,7 @@ const cutOffMultilineMessage = (stack, message) => {
 	const stackSplitByLines = stack.split("\n");
 	const messageSplitByLines = message.split("\n");
 
+	/** @type {string[]} */
 	const result = [];
 
 	stackSplitByLines.forEach((line, idx) => {

package/lib/EvalSourceMapDevToolPlugin.js

@@ -82,6 +82,10 @@ class EvalSourceMapDevToolPlugin {
 							return cachedSource;
 						}
 
+						/**
+						 * @param {Source} r result
+						 * @returns {Source} result
+						 */
 						const result = r => {
 							cache.set(source, r);
 							return r;

package/lib/ExportsInfo.js

@@ -14,6 +14,8 @@ const { forEachRuntime } = require("./util/runtime");
 /** @typedef {import("./Module")} Module */
 /** @typedef {import("./ModuleGraph")} ModuleGraph */
 /** @typedef {import("./ModuleGraphConnection")} ModuleGraphConnection */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("./util/Hash")} Hash */
 
 /** @typedef {typeof UsageState.OnlyPropertiesUsed | typeof UsageState.NoInfo | typeof UsageState.Unknown | typeof UsageState.Used} RuntimeUsageStateType */
@@ -44,6 +46,9 @@ class RestoreProvidedData {
 		this.otherTerminalBinding = otherTerminalBinding;
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize({ write }) {
 		write(this.exports);
 		write(this.otherProvided);
@@ -51,6 +56,10 @@ class RestoreProvidedData {
 		write(this.otherTerminalBinding);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 * @returns {RestoreProvidedData} RestoreProvidedData
+	 */
 	static deserialize({ read }) {
 		return new RestoreProvidedData(read(), read(), read(), read());
 	}
@@ -301,7 +310,12 @@ class ExportsInfo {
 				changed = true;
 			}
 			if (targetKey) {
-				exportInfo.setTarget(targetKey, targetModule, [exportInfo.name], -1);
+				exportInfo.setTarget(
+					targetKey,
+					/** @type {ModuleGraphConnection} */ (targetModule),
+					[exportInfo.name],
+					-1
+				);
 			}
 		}
 		if (this._redirectTo !== undefined) {
@@ -331,7 +345,7 @@ class ExportsInfo {
 			if (targetKey) {
 				this._otherExportsInfo.setTarget(
 					targetKey,
-					targetModule,
+					/** @type {ModuleGraphConnection} */ (targetModule),
 					undefined,
 					priority
 				);
@@ -1226,7 +1240,7 @@ class ExportInfo {
 	/**
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {function(Module): boolean} validTargetModuleFilter a valid target module
-	 * @param {Set<ExportInfo> | undefined} alreadyVisited set of already visited export info to avoid circular references
+	 * @param {Set<ExportInfo>} alreadyVisited set of already visited export info to avoid circular references
 	 * @returns {{ module: Module, export: string[] | undefined } | undefined | false} the target, undefined when there is no target, false when no target is valid
 	 */
 	_findTarget(moduleGraph, validTargetModuleFilter, alreadyVisited) {

package/lib/ExportsInfoApiPlugin.js

@@ -14,7 +14,9 @@ const ConstDependency = require("./dependencies/ConstDependency");
 const ExportsInfoDependency = require("./dependencies/ExportsInfoDependency");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Dependency").DependencyLocation} DependencyLocation */
 /** @typedef {import("./javascript/JavascriptParser")} JavascriptParser */
+/** @typedef {import("./javascript/JavascriptParser").Range} Range */
 
 const PLUGIN_NAME = "ExportsInfoApiPlugin";
 
@@ -43,20 +45,27 @@ class ExportsInfoApiPlugin {
 							const dep =
 								members.length >= 2
 									? new ExportsInfoDependency(
-											expr.range,
+											/** @type {Range} */ (expr.range),
 											members.slice(0, -1),
 											members[members.length - 1]
 									  )
-									: new ExportsInfoDependency(expr.range, null, members[0]);
-							dep.loc = expr.loc;
+									: new ExportsInfoDependency(
+											/** @type {Range} */ (expr.range),
+											null,
+											members[0]
+									  );
+							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 							parser.state.module.addDependency(dep);
 							return true;
 						});
 					parser.hooks.expression
 						.for("__webpack_exports_info__")
 						.tap(PLUGIN_NAME, expr => {
-							const dep = new ConstDependency("true", expr.range);
-							dep.loc = expr.loc;
+							const dep = new ConstDependency(
+								"true",
+								/** @type {Range} */ (expr.range)
+							);
+							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 							parser.state.module.addPresentationalDependency(dep);
 							return true;
 						});

package/lib/ExternalModule.js

@@ -384,6 +384,11 @@ const getSourceForDefaultCase = (optional, request, runtimeTemplate) => {
 };
 
 class ExternalModule extends Module {
+	/**
+	 * @param {string | string[] | Record<string, string | string[]>} request request
+	 * @param {TODO} type type
+	 * @param {string} userRequest user request
+	 */
 	constructor(request, type, userRequest) {
 		super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, null);
 

package/lib/FlagAllModulesAsUsedPlugin.js

@@ -8,10 +8,14 @@
 const { getEntryRuntime, mergeRuntimeOwned } = require("./util/runtime");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Module").FactoryMeta} FactoryMeta */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
 const PLUGIN_NAME = "FlagAllModulesAsUsedPlugin";
 class FlagAllModulesAsUsedPlugin {
+	/**
+	 * @param {string} explanation explanation
+	 */
 	constructor(explanation) {
 		this.explanation = explanation;
 	}
@@ -40,7 +44,8 @@ class FlagAllModulesAsUsedPlugin {
 					if (module.factoryMeta === undefined) {
 						module.factoryMeta = {};
 					}
-					module.factoryMeta.sideEffectFree = false;
+					/** @type {FactoryMeta} */
+					(module.factoryMeta).sideEffectFree = false;
 				}
 			});
 		});

package/lib/FlagDependencyUsagePlugin.js

@@ -332,7 +332,9 @@ class FlagDependencyUsagePlugin {
 					}
 
 					while (queue.length) {
-						const [module, runtime] = queue.dequeue();
+						const [module, runtime] = /** @type {[Module, RuntimeSpec]} */ (
+							queue.dequeue()
+						);
 						processModule(module, runtime, false);
 					}
 					logger.timeEnd("trace exports usage in graph");

package/lib/FlagEntryExportAsUsedPlugin.js

@@ -12,6 +12,10 @@ const { getEntryRuntime } = require("./util/runtime");
 const PLUGIN_NAME = "FlagEntryExportAsUsedPlugin";
 
 class FlagEntryExportAsUsedPlugin {
+	/**
+	 * @param {boolean} nsObjectUsed true, if the ns object is used
+	 * @param {string} explanation explanation for the reason
+	 */
 	constructor(nsObjectUsed, explanation) {
 		this.nsObjectUsed = nsObjectUsed;
 		this.explanation = explanation;

package/lib/HotModuleReplacementPlugin.js

@@ -189,6 +189,10 @@ class HotModuleReplacementPlugin {
 			return true;
 		};
 
+		/**
+		 * @param {JavascriptParser} parser the parser
+		 * @returns {void}
+		 */
 		const applyModuleHot = parser => {
 			parser.hooks.evaluateIdentifier.for("module.hot").tap(
 				{
@@ -221,6 +225,10 @@ class HotModuleReplacementPlugin {
 				.tap(PLUGIN_NAME, createHMRExpressionHandler(parser));
 		};
 
+		/**
+		 * @param {JavascriptParser} parser the parser
+		 * @returns {void}
+		 */
 		const applyImportMetaHot = parser => {
 			parser.hooks.evaluateIdentifier
 				.for("import.meta.webpackHot")

package/lib/InitFragment.js

@@ -10,17 +10,21 @@ const makeSerializable = require("./util/makeSerializable");
 
 /** @typedef {import("webpack-sources").Source} Source */
 /** @typedef {import("./Generator").GenerateContext} GenerateContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 /**
- * @param {InitFragment} fragment the init fragment
+ * @template T
+ * @param {InitFragment<T>} fragment the init fragment
  * @param {number} index index
- * @returns {[InitFragment, number]} tuple with both
+ * @returns {[InitFragment<T>, number]} tuple with both
  */
 const extractFragmentIndex = (fragment, index) => [fragment, index];
 
 /**
- * @param {[InitFragment, number]} a first pair
- * @param {[InitFragment, number]} b second pair
+ * @template T
+ * @param {[InitFragment<T>, number]} a first pair
+ * @param {[InitFragment<T>, number]} b second pair
  * @returns {number} sort value
  */
 const sortFragmentWithIndex = ([a, i], [b, j]) => {
@@ -66,6 +70,14 @@ class InitFragment {
 		return this.endContent;
 	}
 
+	/**
+	 * @template Context
+	 * @template T
+	 * @param {Source} source sources
+	 * @param {InitFragment<T>[]} initFragments init fragments
+	 * @param {Context} context context
+	 * @returns {Source} source
+	 */
 	static addToSource(source, initFragments, context) {
 		if (initFragments.length > 0) {
 			// Sort fragments by position. If 2 fragments have the same position,
@@ -77,7 +89,12 @@ class InitFragment {
 			// Deduplicate fragments. If a fragment has no key, it is always included.
 			const keyedFragments = new Map();
 			for (const [fragment] of sortedFragments) {
-				if (typeof fragment.mergeAll === "function") {
+				if (
+					typeof (
+						/** @type {InitFragment<T> & { mergeAll?: (fragments: InitFragment[]) => InitFragment[] }} */
+						(fragment).mergeAll
+					) === "function"
+				) {
 					if (!fragment.key) {
 						throw new Error(
 							`InitFragment with mergeAll function must have a valid key: ${fragment.constructor.name}`
@@ -125,6 +142,9 @@ class InitFragment {
 		}
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 
@@ -135,6 +155,9 @@ class InitFragment {
 		write(this.endContent);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 

package/lib/JavascriptMetaInfoPlugin.js

@@ -13,6 +13,7 @@ const {
 const InnerGraph = require("./optimize/InnerGraph");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Module").BuildInfo} BuildInfo */
 /** @typedef {import("./javascript/JavascriptParser")} JavascriptParser */
 
 const PLUGIN_NAME = "JavascriptMetaInfoPlugin";
@@ -33,8 +34,11 @@ class JavascriptMetaInfoPlugin {
 				 */
 				const handler = parser => {
 					parser.hooks.call.for("eval").tap(PLUGIN_NAME, () => {
-						parser.state.module.buildInfo.moduleConcatenationBailout = "eval()";
-						parser.state.module.buildInfo.usingEval = true;
+						const buildInfo =
+							/** @type {BuildInfo} */
+							(parser.state.module.buildInfo);
+						buildInfo.moduleConcatenationBailout = "eval()";
+						buildInfo.usingEval = true;
 						const currentSymbol = InnerGraph.getTopLevelSymbol(parser.state);
 						if (currentSymbol) {
 							InnerGraph.addUsage(parser.state, null, currentSymbol);
@@ -43,11 +47,12 @@ class JavascriptMetaInfoPlugin {
 						}
 					});
 					parser.hooks.finish.tap(PLUGIN_NAME, () => {
-						let topLevelDeclarations =
-							parser.state.module.buildInfo.topLevelDeclarations;
+						const buildInfo =
+							/** @type {BuildInfo} */
+							(parser.state.module.buildInfo);
+						let topLevelDeclarations = buildInfo.topLevelDeclarations;
 						if (topLevelDeclarations === undefined) {
-							topLevelDeclarations =
-								parser.state.module.buildInfo.topLevelDeclarations = new Set();
+							topLevelDeclarations = buildInfo.topLevelDeclarations = new Set();
 						}
 						for (const name of parser.scope.definitions.asSet()) {
 							const freeInfo = parser.getFreeInfoFromVariable(name);

package/lib/LibManifestPlugin.js

@@ -12,15 +12,29 @@ const { compareModulesById } = require("./util/comparators");
 const { dirname, mkdirp } = require("./util/fs");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Module").BuildMeta} BuildMeta */
 
 /**
  * @typedef {Object} ManifestModuleData
  * @property {string | number} id
- * @property {Object} buildMeta
- * @property {boolean | string[]} exports
+ * @property {BuildMeta} buildMeta
+ * @property {boolean | string[] | undefined} exports
+ */
+
+/**
+ * @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.
+ * @property {string=} name Name of the exposed dll function (external name, use value of 'output.library').
+ * @property {string} path Absolute path to the manifest json file (output).
+ * @property {string=} type Type of the dll bundle (external type, use value of 'output.libraryTarget').
  */
 
 class LibManifestPlugin {
+	/**
+	 * @param {LibManifestPluginOptions} options the options
+	 */
 	constructor(options) {
 		this.options = options;
 	}
@@ -67,7 +81,9 @@ class LibManifestPlugin {
 								continue;
 							}
 							const ident = module.libIdent({
-								context: this.options.context || compiler.options.context,
+								context:
+									this.options.context ||
+									/** @type {string} */ (compiler.options.context),
 								associatedObjectForCache: compiler.root
 							});
 							if (ident) {
@@ -76,7 +92,7 @@ class LibManifestPlugin {
 								/** @type {ManifestModuleData} */
 								const data = {
 									id: chunkGraph.getModuleId(module),
-									buildMeta: module.buildMeta,
+									buildMeta: /** @type {BuildMeta} */ (module.buildMeta),
 									exports: Array.isArray(providedExports)
 										? providedExports
 										: undefined

package/lib/Module.js

@@ -109,6 +109,11 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {KnownBuildMeta & Record<string, any>} BuildMeta */
 /** @typedef {Record<string, any>} BuildInfo */
 
+/**
+ * @typedef {Object} FactoryMeta
+ * @property {boolean=} sideEffectFree
+ */
+
 const EMPTY_RESOLVE_OPTIONS = {};
 
 let debugId = 1000;
@@ -159,7 +164,7 @@ class Module extends DependenciesBlock {
 		// Info from Factory
 		/** @type {ResolveOptions | undefined} */
 		this.resolveOptions = EMPTY_RESOLVE_OPTIONS;
-		/** @type {object | undefined} */
+		/** @type {FactoryMeta | undefined} */
 		this.factoryMeta = undefined;
 		// TODO refactor this -> options object filled from Factory
 		// TODO webpack 6: use an enum
@@ -439,7 +444,7 @@ class Module extends DependenciesBlock {
 
 	/**
 	 * @param {ModuleGraph} moduleGraph the module graph
-	 * @param {boolean} strict the importing module is strict
+	 * @param {boolean | undefined} strict the importing module is strict
 	 * @returns {"namespace" | "default-only" | "default-with-named" | "dynamic"} export type
 	 * "namespace": Exports is already a namespace object. namespace = exports.
 	 * "dynamic": Check at runtime if __esModule is set. When set: namespace = { ...exports, default: exports }. When not set: namespace = { default: exports }.

package/lib/ModuleDependencyError.js

@@ -23,7 +23,7 @@ class ModuleDependencyError extends WebpackError {
 		this.name = "ModuleDependencyError";
 		this.details =
 			err && !(/** @type {any} */ (err).hideStack)
-				? err.stack.split("\n").slice(1).join("\n")
+				? /** @type {string} */ (err.stack).split("\n").slice(1).join("\n")
 				: undefined;
 		this.module = module;
 		this.loc = loc;
@@ -32,7 +32,9 @@ class ModuleDependencyError extends WebpackError {
 
 		if (err && /** @type {any} */ (err).hideStack) {
 			this.stack =
-				err.stack.split("\n").slice(1).join("\n") + "\n\n" + this.stack;
+				/** @type {string} */ (err.stack).split("\n").slice(1).join("\n") +
+				"\n\n" +
+				this.stack;
 		}
 	}
 }

package/lib/ModuleDependencyWarning.js

@@ -23,7 +23,7 @@ class ModuleDependencyWarning extends WebpackError {
 		this.name = "ModuleDependencyWarning";
 		this.details =
 			err && !(/** @type {any} */ (err).hideStack)
-				? err.stack.split("\n").slice(1).join("\n")
+				? /** @type {string} */ (err.stack).split("\n").slice(1).join("\n")
 				: undefined;
 		this.module = module;
 		this.loc = loc;
@@ -32,7 +32,9 @@ class ModuleDependencyWarning extends WebpackError {
 
 		if (err && /** @type {any} */ (err).hideStack) {
 			this.stack =
-				err.stack.split("\n").slice(1).join("\n") + "\n\n" + this.stack;
+				/** @type {string} */ (err.stack).split("\n").slice(1).join("\n") +
+				"\n\n" +
+				this.stack;
 		}
 	}
 }