Merge pull request webpack#7219 from webpack/feature/type-all-the-errors

sokra · web-flow · commit 4073814c3ad4 · 2018-05-26T10:37:26.000+02:00
chore(types): add basic type info for a few warning and errors
diff --git a/lib/AsyncDependencyToInitialChunkError.js b/lib/AsyncDependencyToInitialChunkError.js
@@ -6,7 +6,15 @@
 
 const WebpackError = require("./WebpackError");
 
-module.exports = class AsyncDependencyToInitialChunkError extends WebpackError {
+/** @typedef {import("./Module")} Module */
+
+class AsyncDependencyToInitialChunkError extends WebpackError {
+	/**
+	 * Creates an instance of AsyncDependencyToInitialChunkError.
+	 * @param {string} chunkName Name of Chunk
+	 * @param {Module} module module tied to dependency
+	 * @param {TODO} loc location of dependency
+	 */
 	constructor(chunkName, module, loc) {
 		super();
 
@@ -18,4 +26,6 @@ module.exports = class AsyncDependencyToInitialChunkError extends WebpackError {
 
 		Error.captureStackTrace(this, this.constructor);
 	}
-};
+}
+
+module.exports = AsyncDependencyToInitialChunkError;
diff --git a/lib/CaseSensitiveModulesWarning.js b/lib/CaseSensitiveModulesWarning.js
@@ -6,7 +6,13 @@
 
 const WebpackError = require("./WebpackError");
 
-module.exports = class CaseSensitiveModulesWarning extends WebpackError {
+/** @typedef {import("./Module")} Module */
+
+class CaseSensitiveModulesWarning extends WebpackError {
+	/**
+	 * Creates an instance of CaseSensitiveModulesWarning.
+	 * @param {Module[]} modules modules that were detected
+	 */
 	constructor(modules) {
 		super();
 
@@ -23,6 +29,11 @@ ${modulesList}`;
 		Error.captureStackTrace(this, this.constructor);
 	}
 
+	/**
+	 * @private
+	 * @param {Module[]} modules the modules to be sorted
+	 * @returns {Module[]} sorted version of original modules
+	 */
 	_sort(modules) {
 		return modules.slice().sort((a, b) => {
 			a = a.identifier();
@@ -36,6 +47,11 @@ ${modulesList}`;
 		});
 	}
 
+	/**
+	 * @private
+	 * @param {Module[]} modules each module from throw
+	 * @returns {string} each message from provided moduels
+	 */
 	_moduleMessages(modules) {
 		return modules
 			.map(m => {
@@ -50,4 +66,6 @@ ${modulesList}`;
 			})
 			.join("\n");
 	}
-};
+}
+
+module.exports = CaseSensitiveModulesWarning;
diff --git a/lib/ModuleDependencyError.js b/lib/ModuleDependencyError.js
@@ -7,7 +7,15 @@
 const WebpackError = require("./WebpackError");
 const formatLocation = require("./formatLocation");
 
-module.exports = class ModuleDependencyError extends WebpackError {
+/** @typedef {import("./Module")} Module */
+
+class ModuleDependencyError extends WebpackError {
+	/**
+	 * Creates an instance of ModuleDependencyError.
+	 * @param {Module} module module tied to dependency
+	 * @param {Error} err error thrown
+	 * @param {TODO} loc location of dependency
+	 */
 	constructor(module, err, loc) {
 		super();
 
@@ -22,4 +30,6 @@ module.exports = class ModuleDependencyError extends WebpackError {
 
 		Error.captureStackTrace(this, this.constructor);
 	}
-};
+}
+
+module.exports = ModuleDependencyError;
diff --git a/lib/WebpackError.js b/lib/WebpackError.js
@@ -4,7 +4,11 @@
 */
 "use strict";
 
-module.exports = class WebpackError extends Error {
+class WebpackError extends Error {
+	/**
+	 * Creates an instance of WebpackError.
+	 * @param {string=} message error message
+	 */
 	constructor(message) {
 		super(message);
 
@@ -16,4 +20,6 @@ module.exports = class WebpackError extends Error {
 	inspect() {
 		return this.stack + (this.details ? `\n${this.details}` : "");
 	}
-};
+}
+
+module.exports = WebpackError;
