webpack 5.59.0 → 5.94.0

package/lib/DelegatedModule.js

@@ -7,6 +7,7 @@
 
 const { OriginalSource, RawSource } = require("webpack-sources");
 const Module = require("./Module");
+const { JAVASCRIPT_MODULE_TYPE_DYNAMIC } = require("./ModuleTypeConstants");
 const RuntimeGlobals = require("./RuntimeGlobals");
 const DelegatedSourceDependency = require("./dependencies/DelegatedSourceDependency");
 const StaticExportsDependency = require("./dependencies/StaticExportsDependency");
@@ -24,14 +25,21 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./Module").LibIdentOptions} LibIdentOptions */
 /** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
 /** @typedef {import("./Module").SourceContext} SourceContext */
+/** @typedef {import("./Module").SourceTypes} SourceTypes */
 /** @typedef {import("./RequestShortener")} RequestShortener */
 /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
 /** @typedef {import("./WebpackError")} WebpackError */
 /** @typedef {import("./dependencies/ModuleDependency")} ModuleDependency */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("./util/Hash")} Hash */
 /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
 
+/** @typedef {string} SourceRequest */
+/** @typedef {"require" | "object"} Type */
+/** @typedef {TODO} Data */
+
 const TYPES = new Set(["javascript"]);
 const RUNTIME_REQUIREMENTS = new Set([
 	RuntimeGlobals.module,
@@ -39,8 +47,15 @@ const RUNTIME_REQUIREMENTS = new Set([
 ]);
 
 class DelegatedModule extends Module {
+	/**
+	 * @param {SourceRequest} sourceRequest source request
+	 * @param {Data} data data
+	 * @param {Type} type type
+	 * @param {string} userRequest user request
+	 * @param {string | Module} originalRequest original request
+	 */
 	constructor(sourceRequest, data, type, userRequest, originalRequest) {
-		super("javascript/dynamic", null);
+		super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, null);
 
 		// Info from Factory
 		this.sourceRequest = sourceRequest;
@@ -48,7 +63,7 @@ class DelegatedModule extends Module {
 		this.delegationType = type;
 		this.userRequest = userRequest;
 		this.originalRequest = originalRequest;
-		/** @type {ManifestModuleData} */
+		/** @type {ManifestModuleData | undefined} */
 		this.delegateData = data;
 
 		// Build info
@@ -56,7 +71,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
-	 * @returns {Set<string>} types available (do not mutate)
+	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
 		return TYPES;
@@ -91,7 +106,7 @@ class DelegatedModule extends Module {
 
 	/**
 	 * @param {NeedBuildContext} context context info
-	 * @param {function(WebpackError=, boolean=): void} callback callback function, returns true, if the module needs a rebuild
+	 * @param {function((WebpackError | null)=, boolean=): void} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
 	 */
 	needBuild(context, callback) {
@@ -107,7 +122,8 @@ class DelegatedModule extends Module {
 	 * @returns {void}
 	 */
 	build(options, compilation, resolver, fs, callback) {
-		this.buildMeta = { ...this.delegateData.buildMeta };
+		const delegateData = /** @type {ManifestModuleData} */ (this.delegateData);
+		this.buildMeta = { ...delegateData.buildMeta };
 		this.buildInfo = {};
 		this.dependencies.length = 0;
 		this.delegatedSourceDependency = new DelegatedSourceDependency(
@@ -115,7 +131,7 @@ class DelegatedModule extends Module {
 		);
 		this.addDependency(this.delegatedSourceDependency);
 		this.addDependency(
-			new StaticExportsDependency(this.delegateData.exports || true, false)
+			new StaticExportsDependency(delegateData.exports || true, false)
 		);
 		callback();
 	}
@@ -185,6 +201,9 @@ class DelegatedModule extends Module {
 		super.updateHash(hash, context);
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		// constructor
@@ -196,6 +215,10 @@ class DelegatedModule extends Module {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context\
+	 * @returns {DelegatedModule} DelegatedModule
+	 */
 	static deserialize(context) {
 		const { read } = context;
 		const obj = new DelegatedModule(

package/lib/DelegatedModuleFactoryPlugin.js

@@ -7,19 +7,38 @@
 
 const DelegatedModule = require("./DelegatedModule");
 
-// options.source
-// options.type
-// options.context
-// options.scope
-// options.content
-// options.associatedObjectForCache
+/** @typedef {import("../declarations/plugins/DllReferencePlugin").DllReferencePluginOptions} DllReferencePluginOptions */
+/** @typedef {import("../declarations/plugins/DllReferencePlugin").DllReferencePluginOptionsContent} DllReferencePluginOptionsContent */
+/** @typedef {import("./DelegatedModule").Data} Data */
+/** @typedef {import("./DelegatedModule").SourceRequest} SourceRequest */
+/** @typedef {import("./DelegatedModule").Type} Type */
+/** @typedef {import("./NormalModuleFactory")} NormalModuleFactory */
+
+/**
+ * @typedef {object} Options
+ * @property {SourceRequest} source source
+ * @property {NonNullable<DllReferencePluginOptions["context"]>} context absolute context path to which lib ident is relative to
+ * @property {DllReferencePluginOptionsContent} content content
+ * @property {DllReferencePluginOptions["type"]} type type
+ * @property {DllReferencePluginOptions["extensions"]} extensions extensions
+ * @property {DllReferencePluginOptions["scope"]} scope scope
+ * @property {object=} associatedObjectForCache object for caching
+ */
+
 class DelegatedModuleFactoryPlugin {
+	/**
+	 * @param {Options} options options
+	 */
 	constructor(options) {
 		this.options = options;
 		options.type = options.type || "require";
 		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) {
@@ -29,7 +48,7 @@ class DelegatedModuleFactoryPlugin {
 					const [dependency] = data.dependencies;
 					const { request } = dependency;
 					if (request && request.startsWith(`${scope}/`)) {
-						const innerRequest = "." + request.substr(scope.length);
+						const innerRequest = `.${request.slice(scope.length)}`;
 						let resolved;
 						if (innerRequest in this.options.content) {
 							resolved = this.options.content[innerRequest];
@@ -38,14 +57,17 @@ class DelegatedModuleFactoryPlugin {
 								new DelegatedModule(
 									this.options.source,
 									resolved,
-									this.options.type,
+									/** @type {Type} */ (this.options.type),
 									innerRequest,
 									request
 								)
 							);
 						}
-						for (let i = 0; i < this.options.extensions.length; i++) {
-							const extension = this.options.extensions[i];
+						const extensions =
+							/** @type {string[]} */
+							(this.options.extensions);
+						for (let i = 0; i < extensions.length; i++) {
+							const extension = extensions[i];
 							const requestPlusExt = innerRequest + extension;
 							if (requestPlusExt in this.options.content) {
 								resolved = this.options.content[requestPlusExt];
@@ -54,7 +76,7 @@ class DelegatedModuleFactoryPlugin {
 									new DelegatedModule(
 										this.options.source,
 										resolved,
-										this.options.type,
+										/** @type {Type} */ (this.options.type),
 										requestPlusExt,
 										request + extension
 									)
@@ -70,17 +92,15 @@ class DelegatedModuleFactoryPlugin {
 				"DelegatedModuleFactoryPlugin",
 				module => {
 					const request = module.libIdent(this.options);
-					if (request) {
-						if (request in this.options.content) {
-							const resolved = this.options.content[request];
-							return new DelegatedModule(
-								this.options.source,
-								resolved,
-								this.options.type,
-								request,
-								module
-							);
-						}
+					if (request && request in this.options.content) {
+						const resolved = this.options.content[request];
+						return new DelegatedModule(
+							this.options.source,
+							resolved,
+							/** @type {Type} */ (this.options.type),
+							request,
+							module
+						);
 					}
 					return module;
 				}

package/lib/DelegatedPlugin.js

@@ -9,8 +9,12 @@ const DelegatedModuleFactoryPlugin = require("./DelegatedModuleFactoryPlugin");
 const DelegatedSourceDependency = require("./dependencies/DelegatedSourceDependency");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./DelegatedModuleFactoryPlugin").Options} Options */
 
 class DelegatedPlugin {
+	/**
+	 * @param {Options} options options
+	 */
 	constructor(options) {
 		this.options = options;
 	}

package/lib/DependenciesBlock.js

@@ -12,17 +12,27 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./ChunkGroup")} ChunkGroup */
 /** @typedef {import("./Dependency")} Dependency */
 /** @typedef {import("./Dependency").UpdateHashContext} UpdateHashContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("./util/Hash")} Hash */
 
 /** @typedef {(d: Dependency) => boolean} DependencyFilterFunction */
 
+/**
+ * DependenciesBlock is the base class for all Module classes in webpack. It describes a
+ * "block" of dependencies which are pointers to other DependenciesBlock instances. For example
+ * when a Module has a CommonJs require statement, the DependencyBlock for the CommonJs module
+ * would be added as a dependency to the Module. DependenciesBlock is inherited by two types of classes:
+ * Module subclasses and AsyncDependenciesBlock subclasses. The only difference between the two is that
+ * AsyncDependenciesBlock subclasses are used for code-splitting (async boundary) and Module subclasses are not.
+ */
 class DependenciesBlock {
 	constructor() {
 		/** @type {Dependency[]} */
 		this.dependencies = [];
 		/** @type {AsyncDependenciesBlock[]} */
 		this.blocks = [];
-		/** @type {DependenciesBlock} */
+		/** @type {DependenciesBlock | undefined} */
 		this.parent = undefined;
 	}
 
@@ -36,7 +46,6 @@ class DependenciesBlock {
 	/**
 	 * Adds a DependencyBlock to DependencyBlock relationship.
 	 * This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting)
-	 *
 	 * @param {AsyncDependenciesBlock} block block being added
 	 * @returns {void}
 	 */
@@ -88,11 +97,17 @@ class DependenciesBlock {
 		}
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize({ write }) {
 		write(this.dependencies);
 		write(this.blocks);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize({ read }) {
 		this.dependencies = read();
 		this.blocks = read();

package/lib/Dependency.js

@@ -5,6 +5,7 @@
 
 "use strict";
 
+const RawModule = require("./RawModule");
 const memoize = require("./util/memoize");
 
 /** @typedef {import("webpack-sources").Source} Source */
@@ -17,39 +18,41 @@ const memoize = require("./util/memoize");
 /** @typedef {import("./ModuleGraphConnection").ConnectionState} ConnectionState */
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
 /** @typedef {import("./WebpackError")} WebpackError */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("./util/Hash")} Hash */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
 /**
- * @typedef {Object} UpdateHashContext
+ * @typedef {object} UpdateHashContext
  * @property {ChunkGraph} chunkGraph
  * @property {RuntimeSpec} runtime
  * @property {RuntimeTemplate=} runtimeTemplate
  */
 
 /**
- * @typedef {Object} SourcePosition
+ * @typedef {object} SourcePosition
  * @property {number} line
  * @property {number=} column
  */
 
 /**
- * @typedef {Object} RealDependencyLocation
+ * @typedef {object} RealDependencyLocation
  * @property {SourcePosition} start
  * @property {SourcePosition=} end
  * @property {number=} index
  */
 
 /**
- * @typedef {Object} SyntheticDependencyLocation
+ * @typedef {object} SyntheticDependencyLocation
  * @property {string} name
  * @property {number=} index
  */
 
-/** @typedef {SyntheticDependencyLocation|RealDependencyLocation} DependencyLocation */
+/** @typedef {SyntheticDependencyLocation | RealDependencyLocation} DependencyLocation */
 
 /**
- * @typedef {Object} ExportSpec
+ * @typedef {object} ExportSpec
  * @property {string} name the name of the export
  * @property {boolean=} canMangle can the export be renamed (defaults to true)
  * @property {boolean=} terminalBinding is the export a terminal binding that should be checked for export star conflicts
@@ -61,10 +64,10 @@ const memoize = require("./util/memoize");
  */
 
 /**
- * @typedef {Object} ExportsSpec
+ * @typedef {object} ExportsSpec
  * @property {(string | ExportSpec)[] | true | null} exports exported names, true for unknown exports or null for no exports
  * @property {Set<string>=} excludeExports when exports = true, list of unaffected exports
- * @property {Set<string>=} hideExports list of maybe prior exposed, but now hidden exports
+ * @property {(Set<string> | null)=} hideExports list of maybe prior exposed, but now hidden exports
  * @property {ModuleGraphConnection=} from when reexported: from which module
  * @property {number=} priority when reexported: with which priority
  * @property {boolean=} canMangle can the export be renamed (defaults to true)
@@ -73,23 +76,24 @@ const memoize = require("./util/memoize");
  */
 
 /**
- * @typedef {Object} ReferencedExport
+ * @typedef {object} ReferencedExport
  * @property {string[]} name name of the referenced export
  * @property {boolean=} canMangle when false, referenced export can not be mangled, defaults to true
  */
 
+/** @typedef {function(ModuleGraphConnection, RuntimeSpec): ConnectionState} GetConditionFn */
+
 const TRANSITIVE = Symbol("transitive");
 
-const getIgnoredModule = memoize(() => {
-	const RawModule = require("./RawModule");
-	return new RawModule("/* (ignored) */", `ignored`, `(ignored)`);
-});
+const getIgnoredModule = memoize(
+	() => new RawModule("/* (ignored) */", "ignored", "(ignored)")
+);
 
 class Dependency {
 	constructor() {
-		/** @type {Module} */
+		/** @type {Module | undefined} */
 		this._parentModule = undefined;
-		/** @type {DependenciesBlock} */
+		/** @type {DependenciesBlock | undefined} */
 		this._parentDependenciesBlock = undefined;
 		/** @type {number} */
 		this._parentDependenciesBlockIndex = -1;
@@ -159,19 +163,34 @@ class Dependency {
 			this._locEL = 0;
 			this._locEC = 0;
 		}
-		if ("index" in loc) {
-			this._locI = loc.index;
-		} else {
-			this._locI = undefined;
-		}
-		if ("name" in loc) {
-			this._locN = loc.name;
-		} else {
-			this._locN = undefined;
-		}
+		this._locI = "index" in loc ? loc.index : undefined;
+		this._locN = "name" in loc ? loc.name : undefined;
 		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;
+		this._locEL = endLine;
+		this._locEC = endColumn;
+		this._locI = undefined;
+		this._locN = undefined;
+		this._loc = undefined;
+	}
+
+	/**
+	 * @returns {string | undefined} a request context
+	 */
+	getContext() {
+		return undefined;
+	}
+
 	/**
 	 * @returns {string | null} an identifier to merge equal requests
 	 */
@@ -210,7 +229,7 @@ class Dependency {
 
 	/**
 	 * @param {ModuleGraph} moduleGraph module graph
-	 * @returns {null | false | function(ModuleGraphConnection, RuntimeSpec): ConnectionState} function to determine if the connection is active
+	 * @returns {null | false | GetConditionFn} function to determine if the connection is active
 	 */
 	getCondition(moduleGraph) {
 		return null;
@@ -228,7 +247,7 @@ class Dependency {
 	/**
 	 * Returns warnings
 	 * @param {ModuleGraph} moduleGraph module graph
-	 * @returns {WebpackError[]} warnings
+	 * @returns {WebpackError[] | null | undefined} warnings
 	 */
 	getWarnings(moduleGraph) {
 		return null;
@@ -237,7 +256,7 @@ class Dependency {
 	/**
 	 * Returns errors
 	 * @param {ModuleGraph} moduleGraph module graph
-	 * @returns {WebpackError[]} errors
+	 * @returns {WebpackError[] | null | undefined} errors
 	 */
 	getErrors(moduleGraph) {
 		return null;
@@ -269,12 +288,15 @@ class Dependency {
 
 	/**
 	 * @param {string} context context directory
-	 * @returns {Module} a module
+	 * @returns {Module | null} a module
 	 */
 	createIgnoredModule(context) {
 		return getIgnoredModule();
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize({ write }) {
 		write(this.weak);
 		write(this.optional);
@@ -286,6 +308,9 @@ class Dependency {
 		write(this._locN);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize({ read }) {
 		this.weak = read();
 		this.optional = read();
@@ -303,6 +328,8 @@ Dependency.NO_EXPORTS_REFERENCED = [];
 /** @type {string[][]} */
 Dependency.EXPORTS_OBJECT_REFERENCED = [[]];
 
+// eslint-disable-next-line no-warning-comments
+// @ts-ignore https://github.com/microsoft/TypeScript/issues/42919
 Object.defineProperty(Dependency.prototype, "module", {
 	/**
 	 * @deprecated
@@ -325,6 +352,8 @@ Object.defineProperty(Dependency.prototype, "module", {
 	}
 });
 
+// eslint-disable-next-line no-warning-comments
+// @ts-ignore https://github.com/microsoft/TypeScript/issues/42919
 Object.defineProperty(Dependency.prototype, "disconnect", {
 	get() {
 		throw new Error(

package/lib/DependencyTemplate.js

@@ -7,29 +7,50 @@
 
 /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
 /** @typedef {import("./ChunkGraph")} ChunkGraph */
+/** @typedef {import("./CodeGenerationResults")} CodeGenerationResults */
 /** @typedef {import("./ConcatenationScope")} ConcatenationScope */
 /** @typedef {import("./Dependency")} Dependency */
 /** @typedef {import("./Dependency").RuntimeSpec} RuntimeSpec */
 /** @typedef {import("./DependencyTemplates")} DependencyTemplates */
 /** @typedef {import("./Generator").GenerateContext} GenerateContext */
-/** @template T @typedef {import("./InitFragment")<T>} InitFragment */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./Module").RuntimeRequirements} RuntimeRequirements */
 /** @typedef {import("./ModuleGraph")} ModuleGraph */
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
 
 /**
- * @typedef {Object} DependencyTemplateContext
+ * @template T
+ * @typedef {import("./InitFragment")<T>} InitFragment
+ */
+
+/**
+ * @typedef {object} DependencyTemplateContext
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
  * @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 {Module} module current module
  * @property {RuntimeSpec} runtime current runtimes, for which code is generated
  * @property {InitFragment<GenerateContext>[]} initFragments mutable array of init fragments for the current module
  * @property {ConcatenationScope=} concatenationScope when in a concatenated module, information about other concatenated modules
+ * @property {CodeGenerationResults} codeGenerationResults the code generation results
+ * @property {InitFragment<GenerateContext>[]} chunkInitFragments chunkInitFragments
+ */
+
+/**
+ * @typedef {object} CssDependencyTemplateContextExtras
+ * @property {CssExportsData} cssExportsData the css exports data
  */
 
+/**
+ * @typedef {object} CssExportsData
+ * @property {boolean} esModule whether export __esModule
+ * @property {Map<string, string>} exports the css exports
+ */
+
+/** @typedef {DependencyTemplateContext & CssDependencyTemplateContextExtras} CssDependencyTemplateContext */
+
 class DependencyTemplate {
 	/* istanbul ignore next */
 	/**

package/lib/DependencyTemplates.js

@@ -27,7 +27,7 @@ class DependencyTemplates {
 
 	/**
 	 * @param {DependencyConstructor} dependency Constructor of Dependency
-	 * @returns {DependencyTemplate} template for this dependency
+	 * @returns {DependencyTemplate | undefined} template for this dependency
 	 */
 	get(dependency) {
 		return this._map.get(dependency);
@@ -57,7 +57,7 @@ class DependencyTemplates {
 	}
 
 	clone() {
-		const newInstance = new DependencyTemplates();
+		const newInstance = new DependencyTemplates(this._hashFunction);
 		newInstance._map = new Map(this._map);
 		newInstance._hash = this._hash;
 		return newInstance;

package/lib/DllEntryPlugin.js

@@ -9,13 +9,27 @@ const DllModuleFactory = require("./DllModuleFactory");
 const DllEntryDependency = require("./dependencies/DllEntryDependency");
 const EntryDependency = require("./dependencies/EntryDependency");
 
+/** @typedef {import("./Compiler")} Compiler */
+/** @typedef {string[]} Entries */
+/** @typedef {{ name: string, filename: TODO }} Options */
+
 class DllEntryPlugin {
+	/**
+	 * @param {string} context context
+	 * @param {Entries} entries entry names
+	 * @param {Options} options options
+	 */
 	constructor(context, entries, options) {
 		this.context = context;
 		this.entries = entries;
 		this.options = options;
 	}
 
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
 			"DllEntryPlugin",
@@ -46,7 +60,10 @@ class DllEntryPlugin {
 					this.options.name
 				),
 				this.options,
-				callback
+				error => {
+					if (error) return callback(error);
+					callback();
+				}
 			);
 		});
 	}