@depup/webpack 5.106.1-depup.0 → 5.109.2-depup.0

package/lib/UseStrictPlugin.js

@@ -23,7 +23,7 @@ const PLUGIN_NAME = "UseStrictPlugin";
 
 class UseStrictPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -32,6 +32,7 @@ class UseStrictPlugin {
 			PLUGIN_NAME,
 			(compilation, { normalModuleFactory }) => {
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {JavascriptParserOptions} parserOptions the javascript parser options
 				 */
@@ -51,7 +52,7 @@ class UseStrictPlugin {
 								"",
 								/** @type {Range} */ (firstNode.range)
 							);
-							dep.loc = /** @type {DependencyLocation} */ (firstNode.loc);
+							dep.loc = parser.getLocation(firstNode);
 							parser.state.module.addPresentationalDependency(dep);
 							/** @type {BuildInfo} */
 							(parser.state.module.buildInfo).strict = true;

package/lib/WarnCaseSensitiveModulesPlugin.js

@@ -5,17 +5,86 @@
 
 "use strict";
 
-const CaseSensitiveModulesWarning = require("./CaseSensitiveModulesWarning");
-
 /** @typedef {import("./Compiler")} Compiler */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./ModuleGraph")} ModuleGraph */
 /** @typedef {import("./NormalModule")} NormalModule */
 
+const WebpackError = require("./errors/WebpackError");
+
+/**
+ * Sorts the conflicting modules by identifier to keep warning output stable.
+ * @param {Module[]} modules the modules to be sorted
+ * @returns {Module[]} sorted version of original modules
+ */
+const sortModules = (modules) =>
+	modules.sort((a, b) => {
+		const aIdent = a.identifier();
+		const bIdent = b.identifier();
+		/* istanbul ignore next */
+		if (aIdent < bIdent) return -1;
+		/* istanbul ignore next */
+		if (aIdent > bIdent) return 1;
+		/* istanbul ignore next */
+		return 0;
+	});
+
+/**
+ * Formats the conflicting modules and one representative incoming reason for
+ * each module into the warning body.
+ * @param {Module[]} modules each module from throw
+ * @param {ModuleGraph} moduleGraph the module graph
+ * @returns {string} each message from provided modules
+ */
+const createModulesListMessage = (modules, moduleGraph) =>
+	modules
+		.map((m) => {
+			let message = `* ${m.identifier()}`;
+			const validReasons = [
+				...moduleGraph.getIncomingConnectionsByOriginModule(m).keys()
+			].filter(Boolean);
+
+			if (validReasons.length > 0) {
+				message += `\n    Used by ${validReasons.length} module(s), i. e.`;
+				message += `\n    ${
+					/** @type {Module[]} */ (validReasons)[0].identifier()
+				}`;
+			}
+			return message;
+		})
+		.join("\n");
+
+/**
+ * Warning emitted when webpack finds modules whose identifiers differ only by
+ * letter casing, which can behave inconsistently across filesystems.
+ */
+class CaseSensitiveModulesWarning extends WebpackError {
+	/**
+	 * Builds a warning message that lists the case-conflicting modules and
+	 * representative importers that caused them to be included.
+	 * @param {Iterable<Module>} modules modules that were detected
+	 * @param {ModuleGraph} moduleGraph the module graph
+	 */
+	constructor(modules, moduleGraph) {
+		const sortedModules = sortModules([...modules]);
+		const modulesList = createModulesListMessage(sortedModules, moduleGraph);
+		super(`There are multiple modules with names that only differ in casing.
+This can lead to unexpected behavior when compiling on a filesystem with other case-semantic.
+Use equal casing. Compare these module identifiers:
+${modulesList}`);
+
+		/** @type {string} */
+		this.name = "CaseSensitiveModulesWarning";
+		/** @type {Module} */
+		this.module = sortedModules[0];
+	}
+}
+
 const PLUGIN_NAME = "WarnCaseSensitiveModulesPlugin";
 
 class WarnCaseSensitiveModulesPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/WarnDeprecatedOptionPlugin.js

@@ -5,7 +5,7 @@
 
 "use strict";
 
-const WebpackError = require("./WebpackError");
+const WebpackError = require("./errors/WebpackError");
 
 /** @typedef {import("./Compiler")} Compiler */
 
@@ -19,13 +19,16 @@ class WarnDeprecatedOptionPlugin {
 	 * @param {string} suggestion the suggestion replacement
 	 */
 	constructor(option, value, suggestion) {
+		/** @type {string} */
 		this.option = option;
+		/** @type {string | number} */
 		this.value = value;
+		/** @type {string} */
 		this.suggestion = suggestion;
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -50,6 +53,7 @@ class DeprecatedOptionWarning extends WebpackError {
 
 		/** @type {string} */
 		this.name = "DeprecatedOptionWarning";
+		/** @type {string} */
 		this.message =
 			"configuration\n" +
 			`The value '${value}' for option '${option}' is deprecated. ` +

package/lib/WarnNoModeSetPlugin.js

@@ -5,7 +5,23 @@
 
 "use strict";
 
-const NoModeWarning = require("./NoModeWarning");
+const WebpackError = require("./errors/WebpackError");
+
+class NoModeWarning extends WebpackError {
+	constructor() {
+		super();
+
+		/** @type {string} */
+		this.name = "NoModeWarning";
+		/** @type {string} */
+		this.message =
+			"configuration\n" +
+			"The 'mode' option has not been set, webpack will fallback to 'production' for this value.\n" +
+			"Set 'mode' option to 'development' or 'production' to enable defaults for each environment.\n" +
+			"You can also set it to 'none' to disable any default behavior. " +
+			"Learn more: https://webpack.js.org/configuration/mode/";
+	}
+}
 
 /** @typedef {import("./Compiler")} Compiler */
 
@@ -13,7 +29,7 @@ const PLUGIN_NAME = "WarnNoModeSetPlugin";
 
 class WarnNoModeSetPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/WatchIgnorePlugin.js

@@ -18,10 +18,12 @@ const IGNORE_TIME_ENTRY = "ignore";
 
 class IgnoringWatchFileSystem {
 	/**
+	 * Creates an instance of IgnoringWatchFileSystem.
 	 * @param {WatchFileSystem} wfs original file system
 	 * @param {WatchIgnorePluginOptions["paths"]} paths ignored paths
 	 */
 	constructor(wfs, paths) {
+		/** @type {WatchFileSystem} */
 		this.wfs = wfs;
 		this.paths = paths;
 	}
@@ -31,6 +33,7 @@ class IgnoringWatchFileSystem {
 		files = [...files];
 		dirs = [...dirs];
 		/**
+		 * Returns true, if path is ignored.
 		 * @param {string} path path to check
 		 * @returns {boolean} true, if path is ignored
 		 */
@@ -119,6 +122,7 @@ const PLUGIN_NAME = "WatchIgnorePlugin";
 
 class WatchIgnorePlugin {
 	/**
+	 * Creates an instance of WatchIgnorePlugin.
 	 * @param {WatchIgnorePluginOptions} options options
 	 */
 	constructor(options) {
@@ -127,7 +131,7 @@ class WatchIgnorePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/Watching.js

@@ -11,13 +11,13 @@ const Stats = require("./Stats");
 /** @typedef {import("./Compilation")} Compilation */
 /** @typedef {import("./Compiler")} Compiler */
 /** @typedef {import("./Compiler").ErrorCallback} ErrorCallback */
-/** @typedef {import("./WebpackError")} WebpackError */
 /** @typedef {import("./logging/Logger").Logger} Logger */
 /** @typedef {import("./util/fs").TimeInfoEntries} TimeInfoEntries */
 /** @typedef {import("./util/fs").WatchFileSystem} WatchFileSystem */
 /** @typedef {import("./util/fs").Watcher} Watcher */
 
 /**
+ * Defines the callback type used by this module.
  * @template T
  * @template [R=void]
  * @typedef {import("./webpack").Callback<T, R>} Callback
@@ -27,6 +27,7 @@ const Stats = require("./Stats");
 
 class Watching {
 	/**
+	 * Creates an instance of Watching.
 	 * @param {Compiler} compiler the compiler
 	 * @param {WatchOptions} watchOptions options
 	 * @param {Callback<Stats>} handler completion handler
@@ -34,6 +35,7 @@ class Watching {
 	constructor(compiler, watchOptions, handler) {
 		/** @type {null | number} */
 		this.startTime = null;
+		/** @type {boolean} */
 		this.invalid = false;
 		/** @type {Callback<Stats>} */
 		this.handler = handler;
@@ -41,8 +43,11 @@ class Watching {
 		this.callbacks = [];
 		/** @type {ErrorCallback[] | undefined} */
 		this._closeCallbacks = undefined;
+		/** @type {boolean} */
 		this.closed = false;
+		/** @type {boolean} */
 		this.suspended = false;
+		/** @type {boolean} */
 		this.blocked = false;
 		this._isBlocked = () => false;
 		this._onChange = () => {};
@@ -62,10 +67,15 @@ class Watching {
 		if (typeof this.watchOptions.aggregateTimeout !== "number") {
 			this.watchOptions.aggregateTimeout = 20;
 		}
+		/** @type {Compiler} */
 		this.compiler = compiler;
+		/** @type {boolean} */
 		this.running = false;
+		/** @type {boolean} */
 		this._initial = true;
+		/** @type {boolean} */
 		this._invalidReported = true;
+		/** @type {boolean} */
 		this._needRecords = true;
 		/** @type {undefined | null | Watcher} */
 		this.watcher = undefined;
@@ -82,6 +92,7 @@ class Watching {
 	}
 
 	/**
+	 * Merge with collected.
 	 * @param {ReadonlySet<string> | undefined | null} changedFiles changed files
 	 * @param {ReadonlySet<string> | undefined | null} removedFiles removed files
 	 */
@@ -105,6 +116,7 @@ class Watching {
 	}
 
 	/**
+	 * Processes the provided file time info entries.
 	 * @param {TimeInfoEntries=} fileTimeInfoEntries info for files
 	 * @param {TimeInfoEntries=} contextTimeInfoEntries info for directories
 	 * @param {ReadonlySet<string>=} changedFiles changed files
@@ -183,6 +195,7 @@ class Watching {
 			this.compiler.hooks.watchRun.callAsync(this.compiler, (err) => {
 				if (err) return this._done(err);
 				/**
+				 * Processes the provided err.
 				 * @param {Error | null} err error
 				 * @param {Compilation=} _compilation compilation
 				 * @returns {void}
@@ -242,6 +255,7 @@ class Watching {
 	}
 
 	/**
+	 * Returns the compilation stats.
 	 * @param {Compilation} compilation the compilation
 	 * @returns {Stats} the compilation stats
 	 */
@@ -251,6 +265,7 @@ class Watching {
 	}
 
 	/**
+	 * Processes the provided err.
 	 * @param {(Error | null)=} err an optional error
 	 * @param {Compilation=} compilation the compilation
 	 * @returns {void}
@@ -266,6 +281,7 @@ class Watching {
 		let stats;
 
 		/**
+		 * Processes the provided err.
 		 * @param {Error} err error
 		 * @param {ErrorCallback[]=} cbs callbacks
 		 */
@@ -349,6 +365,7 @@ class Watching {
 	}
 
 	/**
+	 * Processes the provided file.
 	 * @param {Iterable<string>} files watched files
 	 * @param {Iterable<string>} dirs watched directories
 	 * @param {Iterable<string>} missing watched existence entries
@@ -398,6 +415,7 @@ class Watching {
 	}
 
 	/**
+	 * Processes the provided error callback.
 	 * @param {ErrorCallback=} callback signals when the build has completed again
 	 * @returns {void}
 	 */
@@ -414,6 +432,7 @@ class Watching {
 	}
 
 	/**
+	 * Processes the provided file time info entries.
 	 * @param {TimeInfoEntries=} fileTimeInfoEntries info for files
 	 * @param {TimeInfoEntries=} contextTimeInfoEntries info for directories
 	 * @param {ReadonlySet<string>=} changedFiles changed files
@@ -456,6 +475,7 @@ class Watching {
 	}
 
 	/**
+	 * Processes the provided error callback.
 	 * @param {ErrorCallback} callback signals when the watcher is closed
 	 * @returns {void}
 	 */
@@ -467,7 +487,8 @@ class Watching {
 			return;
 		}
 		/**
-		 * @param {WebpackError | null} err error if any
+		 * Processes the provided err.
+		 * @param {Error | null} err error if any
 		 * @param {Compilation=} compilation compilation if any
 		 */
 		const finalCallback = (err, compilation) => {
@@ -481,7 +502,8 @@ class Watching {
 			this.compiler.contextTimestamps = undefined;
 			this.compiler.fsStartTime = undefined;
 			/**
-			 * @param {WebpackError | null} err error if any
+			 * Processes the provided err.
+			 * @param {Error | null} err error if any
 			 */
 			const shutdown = (err) => {
 				this.compiler.hooks.watchClose.call();

package/lib/WebpackError.js

@@ -5,77 +5,6 @@
 
 "use strict";
 
-const inspect = require("util").inspect.custom;
-const makeSerializable = require("./util/makeSerializable");
-
-/** @typedef {import("./Chunk")} Chunk */
-/** @typedef {import("./Dependency").DependencyLocation} DependencyLocation */
-/** @typedef {import("./Module")} Module */
-/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
-/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
-
-class WebpackError extends Error {
-	/**
-	 * Creates an instance of WebpackError.
-	 * @param {string=} message error message
-	 * @param {{ cause?: unknown }} options error options
-	 */
-	constructor(message, options = {}) {
-		super(message, options);
-
-		/** @type {string=} */
-		this.details = undefined;
-		/** @type {(Module | null)=} */
-		this.module = undefined;
-		/** @type {DependencyLocation=} */
-		this.loc = undefined;
-		/** @type {boolean=} */
-		this.hideStack = undefined;
-		/** @type {Chunk=} */
-		this.chunk = undefined;
-		/** @type {string=} */
-		this.file = undefined;
-	}
-
-	/**
-	 * @returns {string} inspect message
-	 */
-	[inspect]() {
-		return (
-			this.stack +
-			(this.details ? `\n${this.details}` : "") +
-			(this.cause ? `\n${this.cause}` : "")
-		);
-	}
-
-	/**
-	 * @param {ObjectSerializerContext} context context
-	 */
-	serialize({ write }) {
-		write(this.name);
-		write(this.message);
-		write(this.stack);
-		write(this.cause);
-		write(this.details);
-		write(this.loc);
-		write(this.hideStack);
-	}
-
-	/**
-	 * @param {ObjectDeserializerContext} context context
-	 */
-	deserialize({ read }) {
-		this.name = read();
-		this.message = read();
-		this.stack = read();
-		this.cause = read();
-		this.details = read();
-		this.loc = read();
-		this.hideStack = read();
-	}
-}
-
-makeSerializable(WebpackError, "webpack/lib/WebpackError");
-
-/** @type {typeof WebpackError} */
-module.exports = WebpackError;
+// TODO remove in webpack 6
+// Some old plugins use `require("webpack/lib/WebpackError")`, in webpack@6 developer should migrate to `compiler.webpack.WebpackError`
+module.exports = require("./errors/WebpackError");

package/lib/WebpackIsIncludedPlugin.js

@@ -5,13 +5,13 @@
 
 "use strict";
 
-const IgnoreErrorModuleFactory = require("./IgnoreErrorModuleFactory");
 const {
 	JAVASCRIPT_MODULE_TYPE_AUTO,
 	JAVASCRIPT_MODULE_TYPE_DYNAMIC,
 	JAVASCRIPT_MODULE_TYPE_ESM
 } = require("./ModuleTypeConstants");
 const WebpackIsIncludedDependency = require("./dependencies/WebpackIsIncludedDependency");
+const IgnoreErrorModuleFactory = require("./errors/IgnoreErrorModuleFactory");
 const {
 	toConstantDependency
 } = require("./javascript/JavascriptParserHelpers");
@@ -25,6 +25,7 @@ const PLUGIN_NAME = "WebpackIsIncludedPlugin";
 
 class WebpackIsIncludedPlugin {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -42,6 +43,7 @@ class WebpackIsIncludedPlugin {
 				);
 
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @returns {void}
 				 */
@@ -65,7 +67,7 @@ class WebpackIsIncludedPlugin {
 								/** @type {string} */ (request.string),
 								/** @type {Range} */ (expr.range)
 							);
-							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+							dep.loc = parser.getLocation(expr);
 							parser.state.module.addDependency(dep);
 							return true;
 						});