webpack 5.59.0 → 5.94.0

package/lib/dependencies/RequireEnsureDependenciesBlockParserPlugin.js

@@ -10,7 +10,17 @@ const RequireEnsureDependency = require("./RequireEnsureDependency");
 const RequireEnsureItemDependency = require("./RequireEnsureItemDependency");
 const getFunctionExpression = require("./getFunctionExpression");
 
+/** @typedef {import("../ChunkGroup").ChunkGroupOptions} ChunkGroupOptions */
+/** @typedef {import("../Dependency").DependencyLocation} DependencyLocation */
+/** @typedef {import("../javascript/BasicEvaluatedExpression")} BasicEvaluatedExpression */
+/** @typedef {import("../javascript/JavascriptParser")} JavascriptParser */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+
 module.exports = class RequireEnsureDependenciesBlockParserPlugin {
+	/**
+	 * @param {JavascriptParser} parser the parser
+	 * @returns {void}
+	 */
 	apply(parser) {
 		parser.hooks.call
 			.for("require.ensure")
@@ -42,9 +52,12 @@ module.exports = class RequireEnsureDependenciesBlockParserPlugin {
 						const dependenciesExpr = parser.evaluateExpression(
 							expr.arguments[0]
 						);
-						const dependenciesItems = dependenciesExpr.isArray()
-							? dependenciesExpr.items
-							: [dependenciesExpr];
+						const dependenciesItems =
+							/** @type {BasicEvaluatedExpression[]} */ (
+								dependenciesExpr.isArray()
+									? dependenciesExpr.items
+									: [dependenciesExpr]
+							);
 						const successExpressionArg = expr.arguments[1];
 						const successExpression =
 							getFunctionExpression(successExpressionArg);
@@ -57,30 +70,34 @@ module.exports = class RequireEnsureDependenciesBlockParserPlugin {
 						}
 
 						const depBlock = new RequireEnsureDependenciesBlock(
-							chunkName,
-							expr.loc
+							/** @type {ChunkGroupOptions & { entryOptions?: TODO }} */
+							(chunkName),
+							/** @type {DependencyLocation} */ (expr.loc)
 						);
 						const errorCallbackExists =
 							expr.arguments.length === 4 ||
 							(!chunkName && expr.arguments.length === 3);
 						const dep = new RequireEnsureDependency(
-							expr.range,
-							expr.arguments[1].range,
-							errorCallbackExists && expr.arguments[2].range
+							/** @type {Range} */ (expr.range),
+							/** @type {Range} */ (expr.arguments[1].range),
+							errorCallbackExists &&
+								/** @type {Range} */ (expr.arguments[2].range)
 						);
-						dep.loc = expr.loc;
+						dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 						depBlock.addDependency(dep);
 						const old = parser.state.current;
-						parser.state.current = depBlock;
+						parser.state.current = /** @type {TODO} */ (depBlock);
 						try {
 							let failed = false;
 							parser.inScope([], () => {
 								for (const ee of dependenciesItems) {
 									if (ee.isString()) {
 										const ensureDependency = new RequireEnsureItemDependency(
-											ee.string
+											/** @type {string} */ (ee.string)
 										);
-										ensureDependency.loc = ee.loc || expr.loc;
+										ensureDependency.loc =
+											/** @type {DependencyLocation} */
+											(expr.loc);
 										depBlock.addDependency(ensureDependency);
 									} else {
 										failed = true;

package/lib/dependencies/RequireEnsureDependency.js

@@ -13,8 +13,16 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("../AsyncDependenciesBlock")} AsyncDependenciesBlock */
 /** @typedef {import("../Dependency")} Dependency */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 class RequireEnsureDependency extends NullDependency {
+	/**
+	 * @param {Range} range range
+	 * @param {Range} contentRange content range
+	 * @param {Range | false} errorHandlerRange error handler range
+	 */
 	constructor(range, contentRange, errorHandlerRange) {
 		super();
 
@@ -27,6 +35,9 @@ class RequireEnsureDependency extends NullDependency {
 		return "require.ensure";
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 
@@ -37,6 +48,9 @@ class RequireEnsureDependency extends NullDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 
@@ -85,14 +99,14 @@ RequireEnsureDependency.Template = class RequireEnsureDependencyTemplate extends
 			source.replace(
 				contentRange[1],
 				errorHandlerRange[0] - 1,
-				").bind(null, __webpack_require__)).catch("
+				`).bind(null, ${RuntimeGlobals.require}))['catch'](`
 			);
 			source.replace(errorHandlerRange[1], range[1] - 1, ")");
 		} else {
 			source.replace(
 				contentRange[1],
 				range[1] - 1,
-				`).bind(null, __webpack_require__)).catch(${RuntimeGlobals.uncaughtErrorHandler})`
+				`).bind(null, ${RuntimeGlobals.require}))['catch'](${RuntimeGlobals.uncaughtErrorHandler})`
 			);
 		}
 	}

package/lib/dependencies/RequireEnsureItemDependency.js

@@ -10,6 +10,9 @@ const ModuleDependency = require("./ModuleDependency");
 const NullDependency = require("./NullDependency");
 
 class RequireEnsureItemDependency extends ModuleDependency {
+	/**
+	 * @param {string} request the request string
+	 */
 	constructor(request) {
 		super(request);
 	}

package/lib/dependencies/RequireEnsurePlugin.js

@@ -10,15 +10,30 @@ const RequireEnsureItemDependency = require("./RequireEnsureItemDependency");
 
 const RequireEnsureDependenciesBlockParserPlugin = require("./RequireEnsureDependenciesBlockParserPlugin");
 
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC
+} = require("../ModuleTypeConstants");
 const {
 	evaluateToString,
 	toConstantDependency
 } = require("../javascript/JavascriptParserHelpers");
 
+/** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
+/** @typedef {import("../Compiler")} Compiler */
+/** @typedef {import("../javascript/JavascriptParser")} Parser */
+
+const PLUGIN_NAME = "RequireEnsurePlugin";
+
 class RequireEnsurePlugin {
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
-			"RequireEnsurePlugin",
+			PLUGIN_NAME,
 			(compilation, { normalModuleFactory }) => {
 				compilation.dependencyFactories.set(
 					RequireEnsureItemDependency,
@@ -34,6 +49,11 @@ class RequireEnsurePlugin {
 					new RequireEnsureDependency.Template()
 				);
 
+				/**
+				 * @param {Parser} parser parser parser
+				 * @param {JavascriptParserOptions} parserOptions parserOptions
+				 * @returns {void}
+				 */
 				const handler = (parser, parserOptions) => {
 					if (
 						parserOptions.requireEnsure !== undefined &&
@@ -44,21 +64,21 @@ class RequireEnsurePlugin {
 					new RequireEnsureDependenciesBlockParserPlugin().apply(parser);
 					parser.hooks.evaluateTypeof
 						.for("require.ensure")
-						.tap("RequireEnsurePlugin", evaluateToString("function"));
+						.tap(PLUGIN_NAME, evaluateToString("function"));
 					parser.hooks.typeof
 						.for("require.ensure")
 						.tap(
-							"RequireEnsurePlugin",
+							PLUGIN_NAME,
 							toConstantDependency(parser, JSON.stringify("function"))
 						);
 				};
 
 				normalModuleFactory.hooks.parser
-					.for("javascript/auto")
-					.tap("RequireEnsurePlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, handler);
 				normalModuleFactory.hooks.parser
-					.for("javascript/dynamic")
-					.tap("RequireEnsurePlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, handler);
 			}
 		);
 	}

package/lib/dependencies/RequireHeaderDependency.js

@@ -12,20 +12,33 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
 /** @typedef {import("../Dependency")} Dependency */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 class RequireHeaderDependency extends NullDependency {
+	/**
+	 * @param {Range} range range
+	 */
 	constructor(range) {
 		super();
 		if (!Array.isArray(range)) throw new Error("range must be valid");
 		this.range = range;
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.range);
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 * @returns {RequireHeaderDependency} RequireHeaderDependency
+	 */
 	static deserialize(context) {
 		const obj = new RequireHeaderDependency(context.read());
 		obj.deserialize(context);
@@ -50,7 +63,7 @@ RequireHeaderDependency.Template = class RequireHeaderDependencyTemplate extends
 	apply(dependency, source, { runtimeRequirements }) {
 		const dep = /** @type {RequireHeaderDependency} */ (dependency);
 		runtimeRequirements.add(RuntimeGlobals.require);
-		source.replace(dep.range[0], dep.range[1] - 1, "__webpack_require__");
+		source.replace(dep.range[0], dep.range[1] - 1, RuntimeGlobals.require);
 	}
 };
 

package/lib/dependencies/RequireIncludeDependency.js

@@ -14,9 +14,14 @@ const ModuleDependency = require("./ModuleDependency");
 /** @typedef {import("../Dependency").ReferencedExport} ReferencedExport */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
 /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
 
 class RequireIncludeDependency extends ModuleDependency {
+	/**
+	 * @param {string} request the request string
+	 * @param {Range} range location in source code
+	 */
 	constructor(request, range) {
 		super(request);
 
@@ -64,7 +69,7 @@ RequireIncludeDependency.Template = class RequireIncludeDependencyTemplate exten
 					`require.include ${runtimeTemplate.requestShortener.shorten(
 						dep.request
 					)}`
-			  )
+				)
 			: "";
 
 		source.replace(dep.range[0], dep.range[1] - 1, `undefined${comment}`);

package/lib/dependencies/RequireIncludeDependencyParserPlugin.js

@@ -13,10 +13,22 @@ const {
 const makeSerializable = require("../util/makeSerializable");
 const RequireIncludeDependency = require("./RequireIncludeDependency");
 
+/** @typedef {import("../Dependency").DependencyLocation} DependencyLocation */
+/** @typedef {import("../javascript/JavascriptParser")} JavascriptParser */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+
 module.exports = class RequireIncludeDependencyParserPlugin {
+	/**
+	 * @param {boolean} warn true: warn about deprecation, false: don't warn
+	 */
 	constructor(warn) {
 		this.warn = warn;
 	}
+
+	/**
+	 * @param {JavascriptParser} parser the parser
+	 * @returns {void}
+	 */
 	apply(parser) {
 		const { warn } = this;
 		parser.hooks.call
@@ -28,12 +40,17 @@ module.exports = class RequireIncludeDependencyParserPlugin {
 
 				if (warn) {
 					parser.state.module.addWarning(
-						new RequireIncludeDeprecationWarning(expr.loc)
+						new RequireIncludeDeprecationWarning(
+							/** @type {DependencyLocation} */ (expr.loc)
+						)
 					);
 				}
 
-				const dep = new RequireIncludeDependency(param.string, expr.range);
-				dep.loc = expr.loc;
+				const dep = new RequireIncludeDependency(
+					/** @type {string} */ (param.string),
+					/** @type {Range} */ (expr.range)
+				);
+				dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 				parser.state.current.addDependency(dep);
 				return true;
 			});
@@ -42,7 +59,9 @@ module.exports = class RequireIncludeDependencyParserPlugin {
 			.tap("RequireIncludePlugin", expr => {
 				if (warn) {
 					parser.state.module.addWarning(
-						new RequireIncludeDeprecationWarning(expr.loc)
+						new RequireIncludeDeprecationWarning(
+							/** @type {DependencyLocation} */ (expr.loc)
+						)
 					);
 				}
 				return evaluateToString("function")(expr);
@@ -52,7 +71,9 @@ module.exports = class RequireIncludeDependencyParserPlugin {
 			.tap("RequireIncludePlugin", expr => {
 				if (warn) {
 					parser.state.module.addWarning(
-						new RequireIncludeDeprecationWarning(expr.loc)
+						new RequireIncludeDeprecationWarning(
+							/** @type {DependencyLocation} */ (expr.loc)
+						)
 					);
 				}
 				return toConstantDependency(parser, JSON.stringify("function"))(expr);
@@ -61,6 +82,9 @@ module.exports = class RequireIncludeDependencyParserPlugin {
 };
 
 class RequireIncludeDeprecationWarning extends WebpackError {
+	/**
+	 * @param {DependencyLocation} loc location
+	 */
 	constructor(loc) {
 		super("require.include() is deprecated and will be removed soon.");
 

package/lib/dependencies/RequireIncludePlugin.js

@@ -5,13 +5,28 @@
 
 "use strict";
 
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC
+} = require("../ModuleTypeConstants");
 const RequireIncludeDependency = require("./RequireIncludeDependency");
 const RequireIncludeDependencyParserPlugin = require("./RequireIncludeDependencyParserPlugin");
 
+/** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
+/** @typedef {import("../Compiler")} Compiler */
+/** @typedef {import("../javascript/JavascriptParser")} Parser */
+
+const PLUGIN_NAME = "RequireIncludePlugin";
+
 class RequireIncludePlugin {
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
-			"RequireIncludePlugin",
+			PLUGIN_NAME,
 			(compilation, { normalModuleFactory }) => {
 				compilation.dependencyFactories.set(
 					RequireIncludeDependency,
@@ -22,6 +37,11 @@ class RequireIncludePlugin {
 					new RequireIncludeDependency.Template()
 				);
 
+				/**
+				 * @param {Parser} parser parser parser
+				 * @param {JavascriptParserOptions} parserOptions parserOptions
+				 * @returns {void}
+				 */
 				const handler = (parser, parserOptions) => {
 					if (parserOptions.requireInclude === false) return;
 					const warn = parserOptions.requireInclude === undefined;
@@ -30,11 +50,11 @@ class RequireIncludePlugin {
 				};
 
 				normalModuleFactory.hooks.parser
-					.for("javascript/auto")
-					.tap("RequireIncludePlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, handler);
 				normalModuleFactory.hooks.parser
-					.for("javascript/dynamic")
-					.tap("RequireIncludePlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, handler);
 			}
 		);
 	}

package/lib/dependencies/RequireResolveContextDependency.js

@@ -9,9 +9,20 @@ const makeSerializable = require("../util/makeSerializable");
 const ContextDependency = require("./ContextDependency");
 const ContextDependencyTemplateAsId = require("./ContextDependencyTemplateAsId");
 
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
+/** @typedef {import("./ContextDependency").ContextDependencyOptions} ContextDependencyOptions */
+
 class RequireResolveContextDependency extends ContextDependency {
-	constructor(options, range, valueRange) {
-		super(options);
+	/**
+	 * @param {ContextDependencyOptions} options options
+	 * @param {Range} range range
+	 * @param {Range} valueRange value range
+	 * @param {TODO} context context
+	 */
+	constructor(options, range, valueRange, context) {
+		super(options, context);
 
 		this.range = range;
 		this.valueRange = valueRange;
@@ -21,6 +32,9 @@ class RequireResolveContextDependency extends ContextDependency {
 		return "amd require context";
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 
@@ -30,6 +44,9 @@ class RequireResolveContextDependency extends ContextDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 

package/lib/dependencies/RequireResolveDependency.js

@@ -12,13 +12,20 @@ const ModuleDependencyAsId = require("./ModuleDependencyTemplateAsId");
 
 /** @typedef {import("../Dependency").ReferencedExport} ReferencedExport */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
 /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
 
 class RequireResolveDependency extends ModuleDependency {
-	constructor(request, range) {
+	/**
+	 * @param {string} request the request string
+	 * @param {Range} range location in source code
+	 * @param {string} [context] context
+	 */
+	constructor(request, range, context) {
 		super(request);
 
 		this.range = range;
+		this._context = context;
 	}
 
 	get type() {

package/lib/dependencies/RequireResolveHeaderDependency.js

@@ -11,8 +11,14 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
 /** @typedef {import("../Dependency")} Dependency */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 class RequireResolveHeaderDependency extends NullDependency {
+	/**
+	 * @param {Range} range range
+	 */
 	constructor(range) {
 		super();
 
@@ -21,6 +27,9 @@ class RequireResolveHeaderDependency extends NullDependency {
 		this.range = range;
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 
@@ -29,6 +38,10 @@ class RequireResolveHeaderDependency extends NullDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 * @returns {RequireResolveHeaderDependency} RequireResolveHeaderDependency
+	 */
 	static deserialize(context) {
 		const obj = new RequireResolveHeaderDependency(context.read());
 		obj.deserialize(context);
@@ -55,6 +68,11 @@ RequireResolveHeaderDependency.Template = class RequireResolveHeaderDependencyTe
 		source.replace(dep.range[0], dep.range[1] - 1, "/*require.resolve*/");
 	}
 
+	/**
+	 * @param {string} name name
+	 * @param {RequireResolveHeaderDependency} dep dependency
+	 * @param {ReplaceSource} source source
+	 */
 	applyAsTemplateArgument(name, dep, source) {
 		source.replace(dep.range[0], dep.range[1] - 1, "/*require.resolve*/");
 	}

package/lib/dependencies/RuntimeRequirementsDependency.js

@@ -14,6 +14,8 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("../Dependency").UpdateHashContext} UpdateHashContext */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("../util/Hash")} Hash */
 
 class RuntimeRequirementsDependency extends NullDependency {
@@ -34,17 +36,23 @@ class RuntimeRequirementsDependency extends NullDependency {
 	 */
 	updateHash(hash, context) {
 		if (this._hashUpdate === undefined) {
-			this._hashUpdate = Array.from(this.runtimeRequirements).join() + "";
+			this._hashUpdate = `${Array.from(this.runtimeRequirements).join()}`;
 		}
 		hash.update(this._hashUpdate);
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.runtimeRequirements);
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 		this.runtimeRequirements = read();

package/lib/dependencies/StaticExportsDependency.js

@@ -13,6 +13,8 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("../Dependency").ExportsSpec} ExportsSpec */
 /** @typedef {import("../Dependency").UpdateHashContext} UpdateHashContext */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("../util/Hash")} Hash */
 
 class StaticExportsDependency extends NullDependency {
@@ -43,6 +45,9 @@ class StaticExportsDependency extends NullDependency {
 		};
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.exports);
@@ -50,6 +55,9 @@ class StaticExportsDependency extends NullDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 		this.exports = read();