webpack 5.106.1 → 5.106.2

package/lib/sharing/ConsumeSharedModule.js

@@ -47,6 +47,7 @@ const fallbackModuleCache = new WeakMap();
 /** @typedef {import("../Module").BasicSourceTypes} BasicSourceTypes */
 
 /**
+ * Represents the consume shared module runtime component.
  * @typedef {object} ConsumeOptions
  * @property {string=} import fallback request
  * @property {string=} importResolved resolved fallback request
@@ -61,6 +62,7 @@ const fallbackModuleCache = new WeakMap();
 
 class ConsumeSharedModule extends Module {
 	/**
+	 * Creates an instance of ConsumeSharedModule.
 	 * @param {string} context context
 	 * @param {ConsumeOptions} options consume options
 	 */
@@ -70,6 +72,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -88,6 +91,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -111,6 +115,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -124,6 +129,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Checks whether the module needs to be rebuilt for the current build state.
 	 * @param {NeedBuildContext} context context info
 	 * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
@@ -133,6 +139,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
 	 * @param {ResolverWithOptions} resolver the resolver
@@ -157,6 +164,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -177,6 +185,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Get fallback module.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {Module | null} fallback module
 	 */
@@ -213,6 +222,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns export type.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {boolean | undefined} strict the importing module is strict
 	 * @returns {ExportsType} export type
@@ -228,6 +238,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {string=} type the source type for which the size should be estimated
 	 * @returns {number} the estimated size of the module (must be non-zero)
 	 */
@@ -236,6 +247,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash used to track dependencies
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -246,6 +258,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -318,6 +331,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -327,6 +341,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/sharing/ConsumeSharedPlugin.js

@@ -37,6 +37,7 @@ const PLUGIN_NAME = "ConsumeSharedPlugin";
 
 class ConsumeSharedPlugin {
 	/**
+	 * Creates an instance of ConsumeSharedPlugin.
 	 * @param {ConsumeSharedPluginOptions} options options
 	 */
 	constructor(options) {
@@ -44,7 +45,7 @@ class ConsumeSharedPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -149,6 +150,7 @@ class ConsumeSharedPlugin {
 				);
 
 				/**
+				 * Creates a consume shared module.
 				 * @param {string} context issuer directory
 				 * @param {string} request request
 				 * @param {ConsumeOptions} config options
@@ -156,6 +158,7 @@ class ConsumeSharedPlugin {
 				 */
 				const createConsumeSharedModule = (context, request, config) => {
 					/**
+					 * Required version warning.
 					 * @param {string} details details
 					 */
 					const requiredVersionWarning = (details) => {
@@ -171,6 +174,7 @@ class ConsumeSharedPlugin {
 					return Promise.all([
 						new Promise(
 							/**
+							 * Handles the callback logic for this hook.
 							 * @param {(value?: string) => void} resolve resolve
 							 */
 							(resolve) => {
@@ -214,6 +218,7 @@ class ConsumeSharedPlugin {
 						),
 						new Promise(
 							/**
+							 * Handles the name callback for this hook.
 							 * @param {(value?: SemVerRange) => void} resolve resolve
 							 */
 							(resolve) => {

package/lib/sharing/ConsumeSharedRuntimeModule.js

@@ -35,6 +35,7 @@ class ConsumeSharedRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/sharing/ProvideForSharedDependency.js

@@ -10,6 +10,7 @@ const makeSerializable = require("../util/makeSerializable");
 
 class ProvideForSharedDependency extends ModuleDependency {
 	/**
+	 * Creates an instance of ProvideForSharedDependency.
 	 * @param {string} request request string
 	 */
 	constructor(request) {

package/lib/sharing/ProvideSharedDependency.js

@@ -13,6 +13,7 @@ const makeSerializable = require("../util/makeSerializable");
 
 class ProvideSharedDependency extends Dependency {
 	/**
+	 * Creates an instance of ProvideSharedDependency.
 	 * @param {string} shareScope share scope
 	 * @param {string} name module name
 	 * @param {string | false} version version
@@ -33,6 +34,7 @@ class ProvideSharedDependency extends Dependency {
 	}
 
 	/**
+	 * Returns an identifier to merge equal requests.
 	 * @returns {string | null} an identifier to merge equal requests
 	 */
 	getResourceIdentifier() {
@@ -42,6 +44,7 @@ class ProvideSharedDependency extends Dependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -54,6 +57,7 @@ class ProvideSharedDependency extends Dependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {ProvideSharedDependency} deserialize fallback dependency
 	 */

package/lib/sharing/ProvideSharedModule.js

@@ -33,6 +33,7 @@ const ProvideForSharedDependency = require("./ProvideForSharedDependency");
 
 class ProvideSharedModule extends Module {
 	/**
+	 * Creates an instance of ProvideSharedModule.
 	 * @param {string} shareScope shared scope name
 	 * @param {string} name shared key
 	 * @param {string | false} version version
@@ -49,6 +50,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -56,6 +58,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -66,6 +69,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -76,6 +80,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Checks whether the module needs to be rebuilt for the current build state.
 	 * @param {NeedBuildContext} context context info
 	 * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
@@ -85,6 +90,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
 	 * @param {ResolverWithOptions} resolver the resolver
@@ -112,6 +118,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {string=} type the source type for which the size should be estimated
 	 * @returns {number} the estimated size of the module (must be non-zero)
 	 */
@@ -120,6 +127,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -127,6 +135,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -164,6 +173,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -177,6 +187,7 @@ class ProvideSharedModule extends Module {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {ProvideSharedModule} deserialize fallback dependency
 	 */

package/lib/sharing/ProvideSharedModuleFactory.js

@@ -14,6 +14,7 @@ const ProvideSharedModule = require("./ProvideSharedModule");
 
 class ProvideSharedModuleFactory extends ModuleFactory {
 	/**
+	 * Processes the provided data.
 	 * @param {ModuleFactoryCreateData} data data object
 	 * @param {ModuleFactoryCallback} callback callback
 	 * @returns {void}

package/lib/sharing/ProvideSharedPlugin.js

@@ -17,6 +17,7 @@ const ProvideSharedModuleFactory = require("./ProvideSharedModuleFactory");
 /** @typedef {import("../NormalModuleFactory").NormalModuleCreateData} NormalModuleCreateData */
 
 /**
+ * Defines the provide options type used by this module.
  * @typedef {object} ProvideOptions
  * @property {string} shareKey
  * @property {string} shareScope
@@ -30,6 +31,7 @@ const PLUGIN_NAME = "ProvideSharedPlugin";
 
 class ProvideSharedPlugin {
 	/**
+	 * Creates an instance of ProvideSharedPlugin.
 	 * @param {ProvideSharedPluginOptions} options options
 	 */
 	constructor(options) {
@@ -37,7 +39,7 @@ class ProvideSharedPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -120,6 +122,7 @@ class ProvideSharedPlugin {
 				}
 				compilationData.set(compilation, resolvedProvideMap);
 				/**
+				 * Provide shared module.
 				 * @param {string} key key
 				 * @param {ProvideOptions} config config
 				 * @param {NormalModuleCreateData["resource"]} resource resource

package/lib/sharing/SharePlugin.js

@@ -18,6 +18,7 @@ const { isRequiredVersion } = require("./utils");
 
 class SharePlugin {
 	/**
+	 * Creates an instance of SharePlugin.
 	 * @param {SharePluginOptions} options options
 	 */
 	constructor(options) {
@@ -72,7 +73,7 @@ class SharePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/sharing/ShareRuntimeModule.js

@@ -24,6 +24,7 @@ class ShareRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/sharing/resolveMatchedConfigs.js

@@ -14,11 +14,13 @@ const LazySet = require("../util/LazySet");
 /** @typedef {import("../ResolverFactory").ResolveOptionsWithDependencyType} ResolveOptionsWithDependencyType */
 
 /**
+ * Defines the matched configs item type used by this module.
  * @template T
  * @typedef {Map<string, T>} MatchedConfigsItem
  */
 
 /**
+ * Defines the matched configs type used by this module.
  * @template T
  * @typedef {object} MatchedConfigs
  * @property {MatchedConfigsItem<T>} resolved
@@ -30,6 +32,7 @@ const LazySet = require("../util/LazySet");
 const RESOLVE_OPTIONS = { dependencyType: "esm" };
 
 /**
+ * Returns resolved matchers.
  * @template T
  * @param {Compilation} compilation the compilation
  * @param {[string, T][]} configs to be processed configs

package/lib/sharing/utils.js

@@ -55,6 +55,7 @@ const DEF_GIT_PROTOCOL = "git+ssh://";
 // thanks to https://github.com/npm/hosted-git-info/blob/latest/git-host-info.js
 const extractCommithashByDomain = {
 	/**
+	 * Returns hash.
 	 * @param {string} pathname pathname
 	 * @param {string} hash hash
 	 * @returns {string | undefined} hash
@@ -78,6 +79,7 @@ const extractCommithashByDomain = {
 		return commithash;
 	},
 	/**
+	 * Returns hash.
 	 * @param {string} pathname pathname
 	 * @param {string} hash hash
 	 * @returns {string | undefined} hash
@@ -102,6 +104,7 @@ const extractCommithashByDomain = {
 		return hash;
 	},
 	/**
+	 * Returns hash.
 	 * @param {string} pathname pathname
 	 * @param {string} hash hash
 	 * @returns {string | undefined} hash
@@ -123,6 +126,7 @@ const extractCommithashByDomain = {
 		return hash;
 	},
 	/**
+	 * Returns hash.
 	 * @param {string} pathname pathname
 	 * @param {string} hash hash
 	 * @returns {string | undefined} hash
@@ -291,6 +295,7 @@ function getGitUrlVersion(gitUrl) {
 /** @typedef {{ data: JsonObject, path: string }} DescriptionFile */
 
 /**
+ * Gets description file.
  * @param {InputFileSystem} fs file system
  * @param {string} directory directory to start looking into
  * @param {string[]} descriptionFiles possible description filenames
@@ -361,6 +366,7 @@ const getDescriptionFile = (
 module.exports.getDescriptionFile = getDescriptionFile;
 
 /**
+ * Gets required version from description file.
  * @param {JsonObject} data description file data i.e.: package.json
  * @param {string} packageName name of the dependency
  * @returns {string | undefined} normalized version
@@ -393,6 +399,7 @@ module.exports.getRequiredVersionFromDescriptionFile =
 	getRequiredVersionFromDescriptionFile;
 
 /**
+ * Checks whether this object is required version.
  * @param {string} str maybe required version
  * @returns {boolean} true, if it looks like a version
  */
@@ -403,6 +410,7 @@ function isRequiredVersion(str) {
 module.exports.isRequiredVersion = isRequiredVersion;
 
 /**
+ * Normalizes version.
  * @see https://docs.npmjs.com/cli/v7/configuring-npm/package-json#urls-as-dependencies
  * @param {string} versionDesc version to be normalized
  * @returns {string} normalized version