webpack 5.106.0 → 5.106.2

package/lib/FlagAllModulesAsUsedPlugin.js

@@ -14,6 +14,7 @@ const { getEntryRuntime, mergeRuntimeOwned } = require("./util/runtime");
 const PLUGIN_NAME = "FlagAllModulesAsUsedPlugin";
 class FlagAllModulesAsUsedPlugin {
 	/**
+	 * Creates an instance of FlagAllModulesAsUsedPlugin.
 	 * @param {string} explanation explanation
 	 */
 	constructor(explanation) {
@@ -21,7 +22,7 @@ class FlagAllModulesAsUsedPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/FlagDependencyExportsPlugin.js

@@ -24,7 +24,7 @@ const PLUGIN_LOGGER_NAME = `webpack.${PLUGIN_NAME}`;
 
 class FlagDependencyExportsPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -129,6 +129,7 @@ class FlagDependencyExportsPlugin {
 							let changed = false;
 
 							/**
+							 * Process dependencies block.
 							 * @param {DependenciesBlock} depBlock the dependencies block
 							 * @returns {void}
 							 */
@@ -142,6 +143,7 @@ class FlagDependencyExportsPlugin {
 							};
 
 							/**
+							 * Process dependency.
 							 * @param {Dependency} dep the dependency
 							 * @returns {void}
 							 */
@@ -152,6 +154,7 @@ class FlagDependencyExportsPlugin {
 							};
 
 							/**
+							 * Process exports spec.
 							 * @param {Dependency} dep dependency
 							 * @param {ExportsSpec} exportDesc info
 							 * @returns {void}

package/lib/FlagDependencyUsagePlugin.js

@@ -28,6 +28,7 @@ const PLUGIN_LOGGER_NAME = `webpack.${PLUGIN_NAME}`;
 
 class FlagDependencyUsagePlugin {
 	/**
+	 * Creates an instance of FlagDependencyUsagePlugin.
 	 * @param {boolean} global do a global analysis instead of per runtime
 	 */
 	constructor(global) {
@@ -36,7 +37,7 @@ class FlagDependencyUsagePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -60,6 +61,7 @@ class FlagDependencyUsagePlugin {
 					const queue = new TupleQueue();
 
 					/**
+					 * Process referenced module.
 					 * @param {Module} module module to process
 					 * @param {ReferencedExports} usedExports list of used exports
 					 * @param {RuntimeSpec} runtime part of which runtime
@@ -163,6 +165,7 @@ class FlagDependencyUsagePlugin {
 					};
 
 					/**
+					 * Processes the provided module.
 					 * @param {DependenciesBlock} module the module
 					 * @param {RuntimeSpec} runtime part of which runtime
 					 * @param {boolean} forceSideEffects always apply side effects
@@ -294,6 +297,7 @@ class FlagDependencyUsagePlugin {
 					logger.time("trace exports usage in graph");
 
 					/**
+					 * Process entry dependency.
 					 * @param {Dependency} dep dependency
 					 * @param {RuntimeSpec} runtime runtime
 					 */

package/lib/FlagEntryExportAsUsedPlugin.js

@@ -13,6 +13,7 @@ const PLUGIN_NAME = "FlagEntryExportAsUsedPlugin";
 
 class FlagEntryExportAsUsedPlugin {
 	/**
+	 * Creates an instance of FlagEntryExportAsUsedPlugin.
 	 * @param {boolean} nsObjectUsed true, if the ns object is used
 	 * @param {string} explanation explanation for the reason
 	 */
@@ -22,7 +23,7 @@ class FlagEntryExportAsUsedPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/Generator.js

@@ -24,6 +24,7 @@ const { JAVASCRIPT_TYPE } = require("./ModuleSourceTypeConstants");
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
 /**
+ * Defines the generate context type used by this module.
  * @typedef {object} GenerateContext
  * @property {DependencyTemplates} dependencyTemplates mapping from dependencies to templates
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
@@ -38,6 +39,7 @@ const { JAVASCRIPT_TYPE } = require("./ModuleSourceTypeConstants");
  */
 
 /**
+ * Defines the generate error fn callback.
  * @callback GenerateErrorFn
  * @param {Error} error the error
  * @param {NormalModule} module module for which the code should be generated
@@ -46,6 +48,7 @@ const { JAVASCRIPT_TYPE } = require("./ModuleSourceTypeConstants");
  */
 
 /**
+ * Represents the generator runtime component.
  * @typedef {object} UpdateHashContext
  * @property {NormalModule} module the module
  * @property {ChunkGraph} chunkGraph
@@ -55,6 +58,7 @@ const { JAVASCRIPT_TYPE } = require("./ModuleSourceTypeConstants");
 
 class Generator {
 	/**
+	 * Returns generator by type.
 	 * @param {{ [key in SourceType]?: Generator }} map map of types
 	 * @returns {ByTypeGenerator} generator by type
 	 */
@@ -64,6 +68,7 @@ class Generator {
 
 	/* istanbul ignore next */
 	/**
+	 * Returns the source types available for this module.
 	 * @abstract
 	 * @param {NormalModule} module fresh module
 	 * @returns {SourceTypes} available types (do not mutate)
@@ -76,6 +81,7 @@ class Generator {
 
 	/* istanbul ignore next */
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @abstract
 	 * @param {NormalModule} module the module
 	 * @param {SourceType=} type source type
@@ -89,6 +95,7 @@ class Generator {
 
 	/* istanbul ignore next */
 	/**
+	 * Generates generated code for this runtime module.
 	 * @abstract
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
@@ -104,6 +111,7 @@ class Generator {
 	}
 
 	/**
+	 * Returns the reason this module cannot be concatenated, when one exists.
 	 * @param {NormalModule} module module for which the bailout reason should be determined
 	 * @param {ConcatenationBailoutReasonContext} context context
 	 * @returns {string | undefined} reason why this module can't be concatenated, undefined when it can be concatenated
@@ -113,6 +121,7 @@ class Generator {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash hash that will be modified
 	 * @param {UpdateHashContext} updateHashContext context for updating hash
 	 */
@@ -141,6 +150,7 @@ function generateError(error, module, generateContext) {
 
 class ByTypeGenerator extends Generator {
 	/**
+	 * Creates an instance of ByTypeGenerator.
 	 * @param {{ [key in SourceType]?: Generator }} map map of types
 	 */
 	constructor(map) {
@@ -152,6 +162,7 @@ class ByTypeGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the source types available for this module.
 	 * @param {NormalModule} module fresh module
 	 * @returns {SourceTypes} available types (do not mutate)
 	 */
@@ -160,6 +171,7 @@ class ByTypeGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {NormalModule} module the module
 	 * @param {SourceType=} type source type
 	 * @returns {number} estimate size of the module
@@ -171,6 +183,7 @@ class ByTypeGenerator extends Generator {
 	}
 
 	/**
+	 * Generates generated code for this runtime module.
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
 	 * @returns {Source | null} generated code

package/lib/GraphHelpers.js

@@ -10,6 +10,7 @@
 /** @typedef {import(".").Entrypoint} Entrypoint */
 
 /**
+ * Connects chunk group and chunk.
  * @param {ChunkGroup} chunkGroup the ChunkGroup to connect
  * @param {Chunk} chunk chunk to tie to ChunkGroup
  * @returns {void}
@@ -21,6 +22,7 @@ const connectChunkGroupAndChunk = (chunkGroup, chunk) => {
 };
 
 /**
+ * Connects chunk group parent and child.
  * @param {ChunkGroup} parent parent ChunkGroup to connect
  * @param {ChunkGroup} child child ChunkGroup to connect
  * @returns {void}
@@ -32,6 +34,7 @@ const connectChunkGroupParentAndChild = (parent, child) => {
 };
 
 /**
+ * Connects entrypoint and depend on.
  * @param {Entrypoint} entrypoint the entrypoint
  * @param {Entrypoint} dependOnEntrypoint the dependOnEntrypoint
  * @returns {void}

package/lib/HookWebpackError.js

@@ -12,6 +12,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 /**
+ * Defines the callback callback.
  * @template T
  * @callback Callback
  * @param {Error | null} err
@@ -38,6 +39,7 @@ class HookWebpackError extends WebpackError {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -50,6 +52,7 @@ class HookWebpackError extends WebpackError {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
@@ -67,6 +70,7 @@ makeSerializable(HookWebpackError, "webpack/lib/HookWebpackError");
 module.exports = HookWebpackError;
 
 /**
+ * Creates webpack error.
  * @param {Error} error an error
  * @param {string} hook name of the hook
  * @returns {WebpackError} a webpack error
@@ -79,6 +83,7 @@ const makeWebpackError = (error, hook) => {
 module.exports.makeWebpackError = makeWebpackError;
 
 /**
+ * Creates webpack error callback.
  * @template T
  * @param {(err: WebpackError | null, result?: T) => void} callback webpack error callback
  * @param {string} hook name of hook
@@ -99,6 +104,7 @@ const makeWebpackErrorCallback = (callback, hook) => (err, result) => {
 module.exports.makeWebpackErrorCallback = makeWebpackErrorCallback;
 
 /**
+ * Try run or webpack error.
  * @template T
  * @param {() => T} fn function which will be wrapping in try catch
  * @param {string} hook name of hook

package/lib/HotModuleReplacementPlugin.js

@@ -63,6 +63,7 @@ const {
 /** @typedef {string[]} Requests */
 
 /**
+ * Defines the hmr javascript parser hooks type used by this module.
  * @typedef {object} HMRJavascriptParserHooks
  * @property {SyncBailHook<[Expression | SpreadElement, Requests], void>} hotAcceptCallback
  * @property {SyncBailHook<[CallExpression, Requests], void>} hotAcceptWithoutCallback
@@ -88,6 +89,7 @@ const PLUGIN_NAME = "HotModuleReplacementPlugin";
 
 class HotModuleReplacementPlugin {
 	/**
+	 * Returns the attached hooks.
 	 * @param {JavascriptParser} parser the parser
 	 * @returns {HMRJavascriptParserHooks} the attached hooks
 	 */
@@ -109,7 +111,7 @@ class HotModuleReplacementPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -121,6 +123,7 @@ class HotModuleReplacementPlugin {
 		const runtimeRequirements = [RuntimeGlobals.module];
 
 		/**
+		 * Creates an accept handler.
 		 * @param {JavascriptParser} parser the parser
 		 * @param {typeof ModuleHotAcceptDependency} ParamDependency dependency
 		 * @returns {(expr: CallExpression) => boolean | undefined} callback
@@ -187,6 +190,7 @@ class HotModuleReplacementPlugin {
 		};
 
 		/**
+		 * Creates a decline handler.
 		 * @param {JavascriptParser} parser the parser
 		 * @param {typeof ModuleHotDeclineDependency} ParamDependency dependency
 		 * @returns {(expr: CallExpression) => boolean | undefined} callback
@@ -228,6 +232,7 @@ class HotModuleReplacementPlugin {
 		};
 
 		/**
+		 * Creates a hmr expression handler.
 		 * @param {JavascriptParser} parser the parser
 		 * @returns {(expr: Expression) => boolean | undefined} callback
 		 */
@@ -246,6 +251,7 @@ class HotModuleReplacementPlugin {
 		};
 
 		/**
+		 * Processes the provided parser.
 		 * @param {JavascriptParser} parser the parser
 		 * @returns {void}
 		 */
@@ -281,6 +287,7 @@ class HotModuleReplacementPlugin {
 		};
 
 		/**
+		 * Apply import meta hot.
 		 * @param {JavascriptParser} parser the parser
 		 * @returns {void}
 		 */
@@ -402,6 +409,7 @@ class HotModuleReplacementPlugin {
 					const records = /** @type {Records} */ (compilation.records);
 					for (const chunk of compilation.chunks) {
 						/**
+						 * Returns module hash.
 						 * @param {Module} module module
 						 * @returns {string} module hash
 						 */

package/lib/IgnoreErrorModuleFactory.js

@@ -16,6 +16,7 @@ const ModuleFactory = require("./ModuleFactory");
  */
 class IgnoreErrorModuleFactory extends ModuleFactory {
 	/**
+	 * Creates an instance of IgnoreErrorModuleFactory.
 	 * @param {NormalModuleFactory} normalModuleFactory normalModuleFactory instance
 	 */
 	constructor(normalModuleFactory) {
@@ -25,6 +26,7 @@ class IgnoreErrorModuleFactory extends ModuleFactory {
 	}
 
 	/**
+	 * Processes the provided data.
 	 * @param {ModuleFactoryCreateData} data data object
 	 * @param {ModuleFactoryCallback} callback callback
 	 * @returns {void}

package/lib/IgnorePlugin.js

@@ -19,6 +19,7 @@ const PLUGIN_NAME = "IgnorePlugin";
 
 class IgnorePlugin {
 	/**
+	 * Creates an instance of IgnorePlugin.
 	 * @param {IgnorePluginOptions} options IgnorePlugin options
 	 */
 	constructor(options) {
@@ -58,7 +59,7 @@ class IgnorePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/IgnoreWarningsPlugin.js

@@ -14,6 +14,7 @@ const PLUGIN_NAME = "IgnoreWarningsPlugin";
 
 class IgnoreWarningsPlugin {
 	/**
+	 * Creates an instance of IgnoreWarningsPlugin.
 	 * @param {IgnoreFn[]} ignoreWarnings conditions to ignore warnings
 	 */
 	constructor(ignoreWarnings) {
@@ -22,7 +23,7 @@ class IgnoreWarningsPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/InitFragment.js

@@ -16,6 +16,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {string} InitFragmentKey */
 
 /**
+ * Defines the maybe mergeable init fragment type used by this module.
  * @template GenerateContext
  * @typedef {object} MaybeMergeableInitFragment
  * @property {InitFragmentKey=} key
@@ -28,6 +29,7 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
+ * Extract fragment index.
  * @template T
  * @param {T} fragment the init fragment
  * @param {number} index index
@@ -36,6 +38,7 @@ const makeSerializable = require("./util/makeSerializable");
 const extractFragmentIndex = (fragment, index) => [fragment, index];
 
 /**
+ * Sorts fragment with index.
  * @template T
  * @param {[MaybeMergeableInitFragment<T>, number]} a first pair
  * @param {[MaybeMergeableInitFragment<T>, number]} b second pair
@@ -50,11 +53,13 @@ const sortFragmentWithIndex = ([a, i], [b, j]) => {
 };
 
 /**
+ * Represents InitFragment.
  * @template GenerateContext
  * @implements {MaybeMergeableInitFragment<GenerateContext>}
  */
 class InitFragment {
 	/**
+	 * Creates an instance of InitFragment.
 	 * @param {string | Source | undefined} content the source code that will be included as initialization code
 	 * @param {number} stage category of initialization code (contribute to order)
 	 * @param {number} position position in the category (contribute to order)
@@ -70,6 +75,7 @@ class InitFragment {
 	}
 
 	/**
+	 * Returns the source code that will be included as initialization code.
 	 * @param {GenerateContext} context context
 	 * @returns {string | Source | undefined} the source code that will be included as initialization code
 	 */
@@ -78,6 +84,7 @@ class InitFragment {
 	}
 
 	/**
+	 * Returns the source code that will be included at the end of the module.
 	 * @param {GenerateContext} context context
 	 * @returns {string | Source | undefined} the source code that will be included at the end of the module
 	 */
@@ -86,6 +93,7 @@ class InitFragment {
 	}
 
 	/**
+	 * Adds the provided source to the init fragment.
 	 * @template Context
 	 * @param {Source} source sources
 	 * @param {MaybeMergeableInitFragment<Context>[]} initFragments init fragments
@@ -165,6 +173,7 @@ class InitFragment {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -178,6 +187,7 @@ class InitFragment {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/InvalidDependenciesModuleWarning.js

@@ -12,6 +12,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 class InvalidDependenciesModuleWarning extends WebpackError {
 	/**
+	 * Creates an instance of InvalidDependenciesModuleWarning.
 	 * @param {Module} module module tied to dependency
 	 * @param {Iterable<string>} deps invalid dependencies
 	 */

package/lib/JavascriptMetaInfoPlugin.js

@@ -20,7 +20,7 @@ const PLUGIN_NAME = "JavascriptMetaInfoPlugin";
 
 class JavascriptMetaInfoPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -29,6 +29,7 @@ class JavascriptMetaInfoPlugin {
 			PLUGIN_NAME,
 			(compilation, { normalModuleFactory }) => {
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @returns {void}
 				 */

package/lib/LibManifestPlugin.js

@@ -18,6 +18,7 @@ const { dirname, mkdirp } = require("./util/fs");
 /** @typedef {import("./ExportsInfo").ExportInfoName} ExportInfoName */
 
 /**
+ * Defines the manifest module data type used by this module.
  * @typedef {object} ManifestModuleData
  * @property {ModuleId} id
  * @property {BuildMeta=} buildMeta
@@ -25,6 +26,7 @@ const { dirname, mkdirp } = require("./util/fs");
  */
 
 /**
+ * Defines the lib manifest plugin options type used by this module.
  * @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).
@@ -38,6 +40,7 @@ const PLUGIN_NAME = "LibManifestPlugin";
 
 class LibManifestPlugin {
 	/**
+	 * Creates an instance of LibManifestPlugin.
 	 * @param {LibManifestPluginOptions} options the options
 	 */
 	constructor(options) {
@@ -45,7 +48,7 @@ class LibManifestPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/LibraryTemplatePlugin.js

@@ -17,6 +17,7 @@ const EnableLibraryPlugin = require("./library/EnableLibraryPlugin");
 // TODO webpack 6 remove
 class LibraryTemplatePlugin {
 	/**
+	 * Creates an instance of LibraryTemplatePlugin.
 	 * @param {LibraryName} name name of library
 	 * @param {LibraryType} target type of library
 	 * @param {UmdNamedDefine} umdNamedDefine setting this to true will name the UMD module
@@ -34,7 +35,7 @@ class LibraryTemplatePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/LoaderOptionsPlugin.js

@@ -13,6 +13,7 @@ const NormalModule = require("./NormalModule");
 /** @typedef {import("./ModuleFilenameHelpers").MatchObject} MatchObject  */
 
 /**
+ * Defines the loader context type used by this module.
  * @template T
  * @typedef {import("../declarations/LoaderContext").LoaderContext<T>} LoaderContext
  */
@@ -21,6 +22,7 @@ const PLUGIN_NAME = "LoaderOptionsPlugin";
 
 class LoaderOptionsPlugin {
 	/**
+	 * Creates an instance of LoaderOptionsPlugin.
 	 * @param {LoaderOptionsPluginOptions & MatchObject} options options object
 	 */
 	constructor(options = {}) {
@@ -34,7 +36,7 @@ class LoaderOptionsPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/LoaderTargetPlugin.js

@@ -13,6 +13,7 @@ const PLUGIN_NAME = "LoaderTargetPlugin";
 
 class LoaderTargetPlugin {
 	/**
+	 * Creates an instance of LoaderTargetPlugin.
 	 * @param {string} target the target
 	 */
 	constructor(target) {
@@ -20,7 +21,7 @@ class LoaderTargetPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */