webpack 5.106.1 → 5.106.2

package/lib/rules/RuleSetCompiler.js

@@ -16,10 +16,12 @@ const { SyncHook } = require("tapable");
 /** @typedef {(Falsy | RuleSetRule)[]} RuleSetRules */
 
 /**
+ * Defines the rule condition function type used by this module.
  * @typedef {(value: EffectData[keyof EffectData]) => boolean} RuleConditionFunction
  */
 
 /**
+ * Defines the rule condition type used by this module.
  * @typedef {object} RuleCondition
  * @property {string | string[]} property
  * @property {boolean} matchWhenEmpty
@@ -27,12 +29,14 @@ const { SyncHook } = require("tapable");
  */
 
 /**
+ * Defines the condition type used by this module.
  * @typedef {object} Condition
  * @property {boolean} matchWhenEmpty
  * @property {RuleConditionFunction} fn
  */
 
 /**
+ * Defines the effect data type used by this module.
  * @typedef {object} EffectData
  * @property {string=} resource
  * @property {string=} realResource
@@ -50,6 +54,7 @@ const { SyncHook } = require("tapable");
  */
 
 /**
+ * Defines the compiled rule type used by this module.
  * @typedef {object} CompiledRule
  * @property {RuleCondition[]} conditions
  * @property {(Effect | ((effectData: EffectData) => Effect[]))[]} effects
@@ -60,12 +65,14 @@ const { SyncHook } = require("tapable");
 /** @typedef {"use" | "use-pre" | "use-post"} EffectUseType */
 
 /**
+ * Defines the effect use type used by this module.
  * @typedef {object} EffectUse
  * @property {EffectUseType} type
  * @property {{ loader: string, options?: string | null | Record<string, EXPECTED_ANY>, ident?: string }} value
  */
 
 /**
+ * Defines the effect basic type used by this module.
  * @typedef {object} EffectBasic
  * @property {string} type
  * @property {EXPECTED_ANY} value
@@ -76,12 +83,14 @@ const { SyncHook } = require("tapable");
 /** @typedef {Map<string, RuleSetLoaderOptions>} References */
 
 /**
+ * Defines the rule set type used by this module.
  * @typedef {object} RuleSet
  * @property {References} references map of references in the rule set (may grow over time)
  * @property {(effectData: EffectData) => Effect[]} exec execute the rule set
  */
 
 /**
+ * Defines the keys of types type used by this module.
  * @template T
  * @template {T[keyof T]} V
  * @typedef {({ [key in keyof Required<T>]: Required<T>[key] extends V ? key : never })[keyof T]} KeysOfTypes
@@ -96,6 +105,7 @@ const { SyncHook } = require("tapable");
 
 class RuleSetCompiler {
 	/**
+	 * Creates an instance of RuleSetCompiler.
 	 * @param {RuleSetPlugin[]} plugins plugins
 	 */
 	constructor(plugins) {
@@ -117,6 +127,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Returns compiled RuleSet.
 	 * @param {RuleSetRules} ruleSet raw user provided rules
 	 * @returns {RuleSet} compiled RuleSet
 	 */
@@ -126,6 +137,7 @@ class RuleSetCompiler {
 		const rules = this.compileRules("ruleSet", ruleSet, refs);
 
 		/**
+		 * Returns true, if the rule has matched.
 		 * @param {EffectData} data data passed in
 		 * @param {CompiledRule} rule the compiled rule
 		 * @param {Effect[]} effects an array where effects are pushed to
@@ -203,6 +215,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Returns rules.
 	 * @param {string} path current path
 	 * @param {RuleSetRules} rules the raw rules provided by user
 	 * @param {References} refs references
@@ -221,6 +234,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Returns normalized and compiled rule for processing.
 	 * @param {string} path current path
 	 * @param {RuleSetRule} rule the raw rule provided by user
 	 * @param {References} refs references
@@ -274,6 +288,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Returns compiled condition.
 	 * @param {string} path current path
 	 * @param {RuleSetLoaderOptions} condition user provided condition value
 	 * @returns {Condition} compiled condition
@@ -395,6 +410,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Combine conditions or.
 	 * @param {Condition[]} conditions some conditions
 	 * @returns {Condition} merged condition
 	 */
@@ -414,6 +430,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Combine conditions and.
 	 * @param {Condition[]} conditions some conditions
 	 * @returns {Condition} merged condition
 	 */
@@ -433,6 +450,7 @@ class RuleSetCompiler {
 	}
 
 	/**
+	 * Returns an error object.
 	 * @param {string} path current path
 	 * @param {EXPECTED_ANY} value value at the error location
 	 * @param {string} message message explaining the problem

package/lib/rules/UseEffectRulePlugin.js

@@ -22,6 +22,7 @@ const PLUGIN_NAME = "UseEffectRulePlugin";
 
 class UseEffectRulePlugin {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {RuleSetCompiler} ruleSetCompiler the rule set compiler
 	 * @returns {void}
 	 */
@@ -30,6 +31,7 @@ class UseEffectRulePlugin {
 			PLUGIN_NAME,
 			(path, rule, unhandledProperties, result, references) => {
 				/**
+				 * Processes the provided property.
 				 * @param {keyof RuleSetRule} property property
 				 * @param {string} correctProperty correct property
 				 */
@@ -58,6 +60,7 @@ class UseEffectRulePlugin {
 						(enforce ? `use-${enforce}` : "use");
 
 					/**
+					 * Returns effect.
 					 * @param {string} path options path
 					 * @param {string} defaultIdent default ident when none is provided
 					 * @param {RuleSetUseItem} item user provided use value
@@ -76,6 +79,7 @@ class UseEffectRulePlugin {
 					};
 
 					/**
+					 * Returns effect.
 					 * @param {string} path options path
 					 * @param {string} defaultIdent default ident when none is provided
 					 * @param {Exclude<NonNullable<RuleSetUseItem>, EXPECTED_FUNCTION>} item user provided use value
@@ -117,6 +121,7 @@ class UseEffectRulePlugin {
 					};
 
 					/**
+					 * Use to effects without ident.
 					 * @param {string} path options path
 					 * @param {RuleSetUseItem | (Falsy | RuleSetUseItem)[]} items user provided use value
 					 * @returns {Effect[]} effects
@@ -143,6 +148,7 @@ class UseEffectRulePlugin {
 					};
 
 					/**
+					 * Returns effects.
 					 * @param {string} path current path
 					 * @param {RuleSetUse} items user provided use value
 					 * @returns {(Effect | ((effectData: EffectData) => Effect[]))[]} effects

package/lib/runtime/AsyncModuleRuntimeModule.js

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

package/lib/runtime/AutoPublicPathRuntimeModule.js

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

package/lib/runtime/BaseUriRuntimeModule.js

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

package/lib/runtime/ChunkNameRuntimeModule.js

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

package/lib/runtime/CompatGetDefaultExportRuntimeModule.js

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

package/lib/runtime/CompatRuntimeModule.js

@@ -19,6 +19,7 @@ class CompatRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {
@@ -72,6 +73,7 @@ class CompatRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Returns true, if the runtime module should get it's own scope.
 	 * @returns {boolean} true, if the runtime module should get it's own scope
 	 */
 	shouldIsolate() {

package/lib/runtime/CreateFakeNamespaceObjectRuntimeModule.js

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

package/lib/runtime/CreateScriptRuntimeModule.js

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

package/lib/runtime/CreateScriptUrlRuntimeModule.js

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

package/lib/runtime/DefinePropertyGettersRuntimeModule.js

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

package/lib/runtime/EnsureChunkRuntimeModule.js

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

package/lib/runtime/GetChunkFilenameRuntimeModule.js

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

package/lib/runtime/GetFullHashRuntimeModule.js

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

package/lib/runtime/GetMainFilenameRuntimeModule.js

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

package/lib/runtime/GetTrustedTypesPolicyRuntimeModule.js

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

package/lib/runtime/GlobalRuntimeModule.js

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

package/lib/runtime/HasOwnPropertyRuntimeModule.js

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

package/lib/runtime/HelperRuntimeModule.js

@@ -6,8 +6,13 @@
 
 const RuntimeModule = require("../RuntimeModule");
 
+/**
+ * Base class for runtime modules that only emit helper functions and do not
+ * need special staging or attachment behavior beyond `RuntimeModule`.
+ */
 class HelperRuntimeModule extends RuntimeModule {
 	/**
+	 * Creates a helper runtime module with the provided readable name.
 	 * @param {string} name a readable name
 	 */
 	constructor(name) {

package/lib/runtime/LoadScriptRuntimeModule.js

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

package/lib/runtime/MakeDeferredNamespaceObjectRuntime.js

@@ -58,6 +58,7 @@ class MakeOptimizedDeferredNamespaceObjectRuntimeModule extends HelperRuntimeMod
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {
@@ -108,6 +109,7 @@ class MakeDeferredNamespaceObjectRuntimeModule extends HelperRuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/runtime/MakeNamespaceObjectRuntimeModule.js

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

package/lib/runtime/NonceRuntimeModule.js

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

package/lib/runtime/OnChunksLoadedRuntimeModule.js

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

package/lib/runtime/PublicPathRuntimeModule.js

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

package/lib/runtime/RelativeUrlRuntimeModule.js

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

package/lib/runtime/RuntimeIdRuntimeModule.js

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

package/lib/runtime/StartupChunkDependenciesPlugin.js

@@ -13,6 +13,9 @@ const StartupEntrypointRuntimeModule = require("./StartupEntrypointRuntimeModule
 /** @typedef {import("../Compiler")} Compiler */
 
 /**
+ * Options that describe which chunk loading backend should receive startup
+ * dependency handling and whether the runtime should wait for those chunks
+ * asynchronously.
  * @typedef {object} Options
  * @property {ChunkLoadingType} chunkLoading
  * @property {boolean=} asyncChunkLoading
@@ -20,8 +23,14 @@ const StartupEntrypointRuntimeModule = require("./StartupEntrypointRuntimeModule
 
 const PLUGIN_NAME = "StartupChunkDependenciesPlugin";
 
+/**
+ * Adds runtime modules that delay entry startup until entry-dependent chunks
+ * required by the selected chunk loading strategy have been loaded.
+ */
 class StartupChunkDependenciesPlugin {
 	/**
+	 * Configures which chunk loading implementation this plugin should enhance
+	 * and whether startup waits should use promises or synchronous ensures.
 	 * @param {Options} options options
 	 */
 	constructor(options) {
@@ -35,7 +44,8 @@ class StartupChunkDependenciesPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Registers compilation hooks that attach the startup dependency runtime
+	 * modules to entry chunks using the configured chunk loading mechanism.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -43,6 +53,8 @@ class StartupChunkDependenciesPlugin {
 		compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
 			const globalChunkLoading = compilation.outputOptions.chunkLoading;
 			/**
+			 * Determines whether a chunk uses the chunk loading backend that this
+			 * plugin is responsible for augmenting.
 			 * @param {Chunk} chunk chunk to check
 			 * @returns {boolean} true, when the plugin is enabled for the chunk
 			 */

package/lib/runtime/StartupChunkDependenciesRuntimeModule.js

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

package/lib/runtime/StartupEntrypointRuntimeModule.js

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

package/lib/runtime/SystemContextRuntimeModule.js

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

package/lib/runtime/ToBinaryRuntimeModule.js

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

package/lib/schemes/DataUriPlugin.js

@@ -14,7 +14,7 @@ const PLUGIN_NAME = "DataUriPlugin";
 
 class DataUriPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/schemes/FileUriPlugin.js

@@ -14,7 +14,7 @@ const PLUGIN_NAME = "FileUriPlugin";
 
 class FileUriPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */