webpack 5.106.1 → 5.107.0

package/lib/dependencies/CommonJsFullRequireDependency.js

@@ -10,6 +10,11 @@ const { equals } = require("../util/ArrayHelpers");
 const { getTrimmedIdsAndRange } = require("../util/chainedImports");
 const makeSerializable = require("../util/makeSerializable");
 const { propertyAccess } = require("../util/property");
+const {
+	ESM_MODULE_EXPORTS_NAME,
+	getRequireEsmModuleExportsAccess,
+	isRequireEsmModuleExportsModule
+} = require("./CommonJsDependencyHelpers");
 const ModuleDependency = require("./ModuleDependency");
 
 /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
@@ -26,6 +31,7 @@ const ModuleDependency = require("./ModuleDependency");
 
 class CommonJsFullRequireDependency extends ModuleDependency {
 	/**
+	 * Creates an instance of CommonJsFullRequireDependency.
 	 * @param {string} request the request string
 	 * @param {Range} range location in source code
 	 * @param {ExportInfoName[]} names accessed properties on module
@@ -54,19 +60,28 @@ class CommonJsFullRequireDependency extends ModuleDependency {
 	 * @returns {ReferencedExports} referenced exports
 	 */
 	getReferencedExports(moduleGraph, runtime) {
-		if (this.call) {
-			const importedModule = moduleGraph.getModule(this);
-			if (
-				!importedModule ||
-				importedModule.getExportsType(moduleGraph, false) !== "namespace"
-			) {
-				return [this.names.slice(0, -1)];
-			}
+		const importedModule = moduleGraph.getModule(this);
+		if (
+			importedModule &&
+			isRequireEsmModuleExportsModule(importedModule, moduleGraph)
+		) {
+			// When `require(esm)` unwraps a `"module.exports"` named export, the
+			// user's property access lands on that value (which webpack does not
+			// model), so only the "module.exports" export itself is referenced.
+			return [[ESM_MODULE_EXPORTS_NAME]];
+		}
+		if (
+			this.call &&
+			(!importedModule ||
+				importedModule.getExportsType(moduleGraph, false) !== "namespace")
+		) {
+			return [this.names.slice(0, -1)];
 		}
 		return [this.names];
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -79,6 +94,7 @@ class CommonJsFullRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
@@ -103,6 +119,7 @@ CommonJsFullRequireDependency.Template = class CommonJsFullRequireDependencyTemp
 	ModuleDependency.Template
 ) {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object
@@ -124,6 +141,10 @@ CommonJsFullRequireDependency.Template = class CommonJsFullRequireDependencyTemp
 			runtimeRequirements
 		});
 
+		const esmRequireAccess = importedModule
+			? getRequireEsmModuleExportsAccess(importedModule, moduleGraph, runtime)
+			: null;
+
 		const {
 			trimmedRange: [trimmedRangeStart, trimmedRangeEnd],
 			trimmedIds
@@ -135,7 +156,13 @@ CommonJsFullRequireDependency.Template = class CommonJsFullRequireDependencyTemp
 			dep
 		);
 
-		if (importedModule) {
+		if (esmRequireAccess !== null) {
+			const access = `${esmRequireAccess}${propertyAccess(trimmedIds)}`;
+			requireExpr =
+				dep.asiSafe === true
+					? `(${requireExpr}${access})`
+					: `${requireExpr}${access}`;
+		} else if (importedModule) {
 			const usedImported = moduleGraph
 				.getExportsInfo(importedModule)
 				.getUsedName(trimmedIds, runtime);

package/lib/dependencies/CommonJsImportsParserPlugin.js

@@ -5,9 +5,9 @@
 
 "use strict";
 
-const CommentCompilationWarning = require("../CommentCompilationWarning");
 const RuntimeGlobals = require("../RuntimeGlobals");
-const UnsupportedFeatureWarning = require("../UnsupportedFeatureWarning");
+const CommentCompilationWarning = require("../errors/CommentCompilationWarning");
+const UnsupportedFeatureWarning = require("../errors/UnsupportedFeatureWarning");
 const {
 	evaluateToIdentifier,
 	evaluateToString,
@@ -42,6 +42,7 @@ const RequireResolveHeaderDependency = require("./RequireResolveHeaderDependency
 /** @typedef {import("./LocalModule")} LocalModule */
 
 /**
+ * Defines the common js import settings type used by this module.
  * @typedef {object} CommonJsImportSettings
  * @property {string=} name
  * @property {string} context
@@ -50,6 +51,7 @@ const RequireResolveHeaderDependency = require("./RequireResolveHeaderDependency
 const PLUGIN_NAME = "CommonJsImportsParserPlugin";
 
 /**
+ * Checks whether this object is require call expression.
  * @param {Expression} expression expression
  * @returns {boolean} true, when expression is `require(...)` or `module.require(...)`
  */
@@ -73,6 +75,7 @@ const isRequireCallExpression = (expression) => {
 };
 
 /**
+ * Gets require referenced exports from destructuring.
  * @param {JavascriptParser} parser parser
  * @param {CallExpression | NewExpression} expr expression
  * @returns {RawReferencedExports | null} referenced exports from destructuring
@@ -92,6 +95,7 @@ const getRequireReferencedExportsFromDestructuring = (parser, expr) => {
 };
 
 /**
+ * Creates a require cache dependency.
  * @param {JavascriptParser} parser parser
  * @returns {(expr: Expression) => boolean} handler
  */
@@ -103,6 +107,7 @@ const createRequireCacheDependency = (parser) =>
 	]);
 
 /**
+ * Creates a require as expression handler.
  * @param {JavascriptParser} parser parser
  * @param {JavascriptParserOptions} options options
  * @param {() => undefined | string} getContext context accessor
@@ -132,6 +137,7 @@ const createRequireAsExpressionHandler =
 	};
 
 /**
+ * Creates a require call handler.
  * @param {JavascriptParser} parser parser
  * @param {JavascriptParserOptions} options options
  * @param {() => undefined | string} getContext context accessor
@@ -139,6 +145,7 @@ const createRequireAsExpressionHandler =
  */
 const createRequireCallHandler = (parser, options, getContext) => {
 	/**
+	 * Process require item.
 	 * @param {CallExpression | NewExpression} expr expression
 	 * @param {BasicEvaluatedExpression} param param
 	 * @returns {boolean | void} true when handled
@@ -153,7 +160,8 @@ const createRequireCallHandler = (parser, options, getContext) => {
 				/** @type {string} */ (param.string),
 				/** @type {Range} */ (param.range),
 				getContext(),
-				referencedExports
+				referencedExports,
+				/** @type {Range} */ (expr.range)
 			);
 			dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 			dep.optional = Boolean(parser.scope.inTry);
@@ -162,6 +170,7 @@ const createRequireCallHandler = (parser, options, getContext) => {
 		}
 	};
 	/**
+	 * Process require context.
 	 * @param {CallExpression | NewExpression} expr expression
 	 * @param {BasicEvaluatedExpression} param param
 	 * @returns {boolean | void} true when handled
@@ -278,6 +287,7 @@ const createRequireCallHandler = (parser, options, getContext) => {
 };
 
 /**
+ * Creates a process resolve handler.
  * @param {JavascriptParser} parser parser
  * @param {JavascriptParserOptions} options options
  * @param {() => undefined | string} getContext context accessor
@@ -285,6 +295,7 @@ const createRequireCallHandler = (parser, options, getContext) => {
  */
 const createProcessResolveHandler = (parser, options, getContext) => {
 	/**
+	 * Process resolve item.
 	 * @param {CallExpression} expr call expression
 	 * @param {BasicEvaluatedExpression} param param
 	 * @param {boolean} weak weak
@@ -305,6 +316,7 @@ const createProcessResolveHandler = (parser, options, getContext) => {
 		}
 	};
 	/**
+	 * Process resolve context.
 	 * @param {CallExpression} expr call expression
 	 * @param {BasicEvaluatedExpression} param param
 	 * @param {boolean} weak weak
@@ -395,6 +407,7 @@ const createProcessResolveHandler = (parser, options, getContext) => {
 
 class CommonJsImportsParserPlugin {
 	/**
+	 * Creates an instance of CommonJsImportsParserPlugin.
 	 * @param {JavascriptParserOptions} options parser options
 	 */
 	constructor(options) {
@@ -402,6 +415,7 @@ class CommonJsImportsParserPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {JavascriptParser} parser the parser
 	 * @returns {void}
 	 */
@@ -425,6 +439,7 @@ class CommonJsImportsParserPlugin {
 
 		// #region metadata
 		/**
+		 * Tap require expression.
 		 * @param {string} expression expression
 		 * @param {() => Members} getMembers get members
 		 */
@@ -491,6 +506,7 @@ class CommonJsImportsParserPlugin {
 
 		// #region Renaming
 		/**
+		 * Returns true when set undefined.
 		 * @param {Expression} expr expression
 		 * @returns {boolean} true when set undefined
 		 */
@@ -516,6 +532,7 @@ class CommonJsImportsParserPlugin {
 
 		// #region Require as expression
 		/**
+		 * Require as expression handler.
 		 * @param {Expression} expr expression
 		 * @returns {boolean} true when handled
 		 */
@@ -531,6 +548,7 @@ class CommonJsImportsParserPlugin {
 
 		// #region Require
 		/**
+		 * Creates a require handler.
 		 * @param {boolean} callNew true, when require is called with new
 		 * @returns {(expr: CallExpression | NewExpression) => (boolean | void)} handler
 		 */
@@ -555,6 +573,7 @@ class CommonJsImportsParserPlugin {
 
 		// #region Require with property access
 		/**
+		 * Returns true when handled.
 		 * @param {Expression} expr expression
 		 * @param {CalleeMembers} calleeMembers callee members
 		 * @param {CallExpression} callExpr call expression
@@ -591,6 +610,7 @@ class CommonJsImportsParserPlugin {
 			}
 		};
 		/**
+		 * Call chain handler.
 		 * @param {CallExpression} expr expression
 		 * @param {CalleeMembers} calleeMembers callee members
 		 * @param {CallExpression} callExpr call expression
@@ -644,6 +664,7 @@ class CommonJsImportsParserPlugin {
 
 		// #region Require.resolve
 		/**
+		 * Processes the provided expr.
 		 * @param {CallExpression} expr call expression
 		 * @param {boolean} weak weak
 		 * @returns {boolean | void} true when handled

package/lib/dependencies/CommonJsPlugin.js

@@ -44,7 +44,7 @@ const PLUGIN_NAME = "CommonJsPlugin";
 
 class CommonJsPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -174,6 +174,7 @@ class CommonJsPlugin {
 					});
 
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {Parser} parser parser parser
 				 * @param {JavascriptParserOptions} parserOptions parserOptions
 				 * @returns {void}
@@ -266,6 +267,7 @@ class HarmonyModuleDecoratorRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {
@@ -296,6 +298,7 @@ class NodeModuleDecoratorRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/dependencies/CommonJsRequireContextDependency.js

@@ -21,6 +21,7 @@ const ContextDependencyTemplateAsRequireCall = require("./ContextDependencyTempl
 
 class CommonJsRequireContextDependency extends ContextDependency {
 	/**
+	 * Creates an instance of CommonJsRequireContextDependency.
 	 * @param {ContextDependencyOptions} options options for the context module
 	 * @param {Range} range location in source code
 	 * @param {Range=} valueRange location of the require call
@@ -57,6 +58,7 @@ class CommonJsRequireContextDependency extends ContextDependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -70,6 +72,7 @@ class CommonJsRequireContextDependency extends ContextDependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/dependencies/CommonJsRequireDependency.js

@@ -7,11 +7,18 @@
 
 const Dependency = require("../Dependency");
 const makeSerializable = require("../util/makeSerializable");
+const {
+	ESM_MODULE_EXPORTS_NAME,
+	getRequireEsmModuleExportsAccess,
+	isRequireEsmModuleExportsModule
+} = require("./CommonJsDependencyHelpers");
 const ModuleDependency = require("./ModuleDependency");
-const ModuleDependencyTemplateAsId = require("./ModuleDependencyTemplateAsId");
 
+/** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
 /** @typedef {import("../Dependency").RawReferencedExports} RawReferencedExports */
 /** @typedef {import("../Dependency").ReferencedExports} ReferencedExports */
+/** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
+/** @typedef {import("../Module")} Module */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
 /** @typedef {import("../javascript/JavascriptParser").Range} Range */
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
@@ -20,16 +27,25 @@ const ModuleDependencyTemplateAsId = require("./ModuleDependencyTemplateAsId");
 
 class CommonJsRequireDependency extends ModuleDependency {
 	/**
+	 * Creates an instance of CommonJsRequireDependency.
 	 * @param {string} request request
-	 * @param {Range=} range location in source code
+	 * @param {Range=} range location in source code of the string-literal argument (gets replaced by the module id)
 	 * @param {string=} context request context
 	 * @param {RawReferencedExports | null=} referencedExports list of referenced exports
+	 * @param {Range=} valueRange location in source code of the whole `require(...)` call (for `require(esm)` interop)
 	 */
-	constructor(request, range, context, referencedExports = null) {
+	constructor(
+		request,
+		range,
+		context,
+		referencedExports = null,
+		valueRange = undefined
+	) {
 		super(request);
 		this.range = range;
 		this._context = context;
 		this.referencedExports = referencedExports;
+		this.valueRange = valueRange;
 	}
 
 	get type() {
@@ -47,6 +63,15 @@ class CommonJsRequireDependency extends ModuleDependency {
 	 * @returns {ReferencedExports} referenced exports
 	 */
 	getReferencedExports(moduleGraph, runtime) {
+		const importedModule = moduleGraph.getModule(this);
+		if (
+			importedModule &&
+			isRequireEsmModuleExportsModule(importedModule, moduleGraph)
+		) {
+			// `require(esm)` will unwrap the "module.exports" named export; only
+			// that export is observable through this `require()` call.
+			return [[ESM_MODULE_EXPORTS_NAME]];
+		}
 		if (!this.referencedExports) return Dependency.EXPORTS_OBJECT_REFERENCED;
 		return this.referencedExports.map((name) => ({
 			name,
@@ -55,25 +80,66 @@ class CommonJsRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.referencedExports);
+		write(this.valueRange);
 		super.serialize(context);
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
 		const { read } = context;
 		this.referencedExports = read();
+		this.valueRange = read();
 		super.deserialize(context);
 	}
 }
 
-CommonJsRequireDependency.Template = ModuleDependencyTemplateAsId;
+CommonJsRequireDependency.Template = class CommonJsRequireDependencyTemplate extends (
+	ModuleDependency.Template
+) {
+	/**
+	 * Applies the plugin by registering its hooks on the compiler.
+	 * @param {Dependency} dependency the dependency for which the template should be applied
+	 * @param {ReplaceSource} source the current replace source which can be modified
+	 * @param {DependencyTemplateContext} templateContext the context object
+	 * @returns {void}
+	 */
+	apply(
+		dependency,
+		source,
+		{ runtimeTemplate, moduleGraph, chunkGraph, runtime }
+	) {
+		const dep = /** @type {CommonJsRequireDependency} */ (dependency);
+		if (!dep.range) return;
+		const importedModule = /** @type {Module} */ (moduleGraph.getModule(dep));
+		const content = runtimeTemplate.moduleId({
+			module: importedModule,
+			chunkGraph,
+			request: dep.request,
+			weak: dep.weak
+		});
+		source.replace(dep.range[0], dep.range[1] - 1, content);
+
+		if (dep.valueRange && importedModule) {
+			const access = getRequireEsmModuleExportsAccess(
+				importedModule,
+				moduleGraph,
+				runtime
+			);
+			if (access !== null) {
+				source.insert(dep.valueRange[1], access);
+			}
+		}
+	}
+};
 
 makeSerializable(
 	CommonJsRequireDependency,

package/lib/dependencies/CommonJsSelfReferenceDependency.js

@@ -25,6 +25,7 @@ const NullDependency = require("./NullDependency");
 
 class CommonJsSelfReferenceDependency extends NullDependency {
 	/**
+	 * Creates an instance of CommonJsSelfReferenceDependency.
 	 * @param {Range} range range
 	 * @param {CommonJSDependencyBaseKeywords} base base
 	 * @param {ExportInfoName[]} names names
@@ -47,6 +48,7 @@ class CommonJsSelfReferenceDependency extends NullDependency {
 	}
 
 	/**
+	 * Returns an identifier to merge equal requests.
 	 * @returns {string | null} an identifier to merge equal requests
 	 */
 	getResourceIdentifier() {
@@ -64,6 +66,7 @@ class CommonJsSelfReferenceDependency extends NullDependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -76,6 +79,7 @@ class CommonJsSelfReferenceDependency extends NullDependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
@@ -97,6 +101,7 @@ CommonJsSelfReferenceDependency.Template = class CommonJsSelfReferenceDependency
 	NullDependency.Template
 ) {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object

package/lib/dependencies/ConstDependency.js

@@ -22,6 +22,7 @@ const NullDependency = require("./NullDependency");
 
 class ConstDependency extends NullDependency {
 	/**
+	 * Creates an instance of ConstDependency.
 	 * @param {string} expression the expression
 	 * @param {number | Range} range the source range
 	 * @param {RawRuntimeRequirements | null=} runtimeRequirements runtime requirements
@@ -38,7 +39,7 @@ class ConstDependency extends NullDependency {
 	}
 
 	/**
-	 * Update the hash
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash hash to be updated
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -58,6 +59,7 @@ class ConstDependency extends NullDependency {
 	}
 
 	/**
+	 * Gets module evaluation side effects state.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {ConnectionState} how this dependency connects the module to referencing modules
 	 */
@@ -66,6 +68,7 @@ class ConstDependency extends NullDependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -77,6 +80,7 @@ class ConstDependency extends NullDependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
@@ -94,6 +98,7 @@ ConstDependency.Template = class ConstDependencyTemplate extends (
 	NullDependency.Template
 ) {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object

package/lib/dependencies/ContextDependency.js

@@ -14,7 +14,7 @@ const memoize = require("../util/memoize");
 /** @typedef {import("../ContextModule").ContextOptions} ContextOptions */
 /** @typedef {import("../Dependency").TRANSITIVE} TRANSITIVE */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
-/** @typedef {import("../WebpackError")} WebpackError */
+/** @typedef {import("../errors/WebpackError")} WebpackError */
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
@@ -27,6 +27,7 @@ const getCriticalDependencyWarning = memoize(() =>
 /** @typedef {{ value: string, range: Range }[]} Replaces */
 
 /**
+ * Returns stringified regexp.
  * @param {RegExp | false | null | undefined} r regexp
  * @returns {string} stringified regexp
  */
@@ -34,6 +35,7 @@ const regExpToString = (r) => (r ? String(r) : "");
 
 class ContextDependency extends Dependency {
 	/**
+	 * Creates an instance of ContextDependency.
 	 * @param {ContextDependencyOptions} options options for the context module
 	 * @param {string=} context request context
 	 */
@@ -69,6 +71,7 @@ class ContextDependency extends Dependency {
 	}
 
 	/**
+	 * Returns a request context.
 	 * @returns {string | undefined} a request context
 	 */
 	getContext() {
@@ -80,6 +83,7 @@ class ContextDependency extends Dependency {
 	}
 
 	/**
+	 * Could affect referencing module.
 	 * @returns {boolean | TRANSITIVE} true, when changes to the referenced module could affect the referencing module; TRANSITIVE, when changes to the referenced module could affect referencing modules of the referencing module
 	 */
 	couldAffectReferencingModule() {
@@ -87,6 +91,7 @@ class ContextDependency extends Dependency {
 	}
 
 	/**
+	 * Returns an identifier to merge equal requests.
 	 * @returns {string | null} an identifier to merge equal requests
 	 */
 	getResourceIdentifier() {
@@ -108,7 +113,7 @@ class ContextDependency extends Dependency {
 	}
 
 	/**
-	 * Returns warnings
+	 * Returns warnings.
 	 * @param {ModuleGraph} moduleGraph module graph
 	 * @returns {WebpackError[] | null | undefined} warnings
 	 */
@@ -135,6 +140,7 @@ class ContextDependency extends Dependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -154,6 +160,7 @@ class ContextDependency extends Dependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/dependencies/ContextDependencyHelpers.js

@@ -25,6 +25,7 @@ const { parseResource } = require("../util/identifier");
 const quoteMeta = (str) => str.replace(/[-[\]\\/{}()*+?.^$|]/g, "\\$&");
 
 /**
+ * Split context from prefix.
  * @param {string} prefix prefix
  * @returns {{ prefix: string, context: string }} result
  */
@@ -45,11 +46,13 @@ const splitContextFromPrefix = (prefix) => {
 /** @typedef {{ new (options: ContextDependencyOptions, range: Range, valueRange: Range, ...args: EXPECTED_ANY[]): ContextDependency }} ContextDependencyConstructor */
 
 /**
+ * Defines the get additional dep args type used by this module.
  * @template T
- * @typedef {T extends new (options: ContextDependencyOptions, range: Range, valueRange: Range, ...remains: infer R) => EXPECTED_ANY ? R : []} GetAdditionalDepArgs
+ * @typedef {T extends new (options: ContextDependencyOptions, range: Range, valueRange: Range, ...remains: infer R) => ContextDependency ? R : []} GetAdditionalDepArgs
  */
 
 /**
+ * Returns the created Dependency.
  * @template {ContextDependencyConstructor} T
  * @param {T} Dep the Dependency class
  * @param {Range} range source range

package/lib/dependencies/ContextDependencyTemplateAsId.js

@@ -14,6 +14,7 @@ const ContextDependency = require("./ContextDependency");
 
 class ContextDependencyTemplateAsId extends ContextDependency.Template {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object

package/lib/dependencies/ContextDependencyTemplateAsRequireCall.js

@@ -16,6 +16,7 @@ class ContextDependencyTemplateAsRequireCall
 	extends ContextDependency.Template
 {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object