refactor: more types

webpack · May 7, 2023 · d529199 · d529199
1 parent 74c17ad
commit d529199
Show file tree

Hide file tree

Showing 19 changed files with 95 additions and 22 deletions.
diff --git a/lib/AliasFieldPlugin.js b/lib/AliasFieldPlugin.js
@@ -71,6 +71,7 @@ module.exports = class AliasFieldPlugin {
 					}
 					return callback(null, ignoreObj);
 				}
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					path: /** @type {string} */ (request.descriptionFileRoot),

diff --git a/lib/AliasPlugin.js b/lib/AliasPlugin.js
@@ -79,6 +79,7 @@ module.exports = class AliasPlugin {
 								) {
 									shouldStop = true;
 									const newRequestStr = alias + remainingRequest;
+									/** @type {ResolveRequest} */
 									const obj = {
 										...request,
 										request: newRequestStr,

diff --git a/lib/AppendPlugin.js b/lib/AppendPlugin.js
@@ -7,6 +7,7 @@
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class AppendPlugin {
 	/**
@@ -29,6 +30,7 @@ module.exports = class AppendPlugin {
 		resolver
 			.getHook(this.source)
 			.tapAsync("AppendPlugin", (request, resolveContext, callback) => {
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					path: request.path + this.appending,

diff --git a/lib/CachedInputFileSystem.js b/lib/CachedInputFileSystem.js
@@ -10,6 +10,10 @@ const nextTick = require("process").nextTick;
 /** @typedef {import("./Resolver").FileSystem} FileSystem */
 /** @typedef {import("./Resolver").SyncFileSystem} SyncFileSystem */
 
+/**
+ * @param {string} path path
+ * @returns {string} dirname
+ */
 const dirname = path => {
 	let idx = path.length - 1;
 	while (idx >= 0) {

diff --git a/lib/CloneBasenamePlugin.js b/lib/CloneBasenamePlugin.js
@@ -8,8 +8,14 @@
 const basename = require("./getPaths").basename;
 
 /** @typedef {import("./Resolver")} Resolver */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
+/** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
 
 module.exports = class CloneBasenamePlugin {
+	/**
+	 * @param {string | ResolveStepHook} source source
+	 * @param {string | ResolveStepHook} target target
+	 */
 	constructor(source, target) {
 		this.source = source;
 		this.target = target;
@@ -27,6 +33,7 @@ module.exports = class CloneBasenamePlugin {
 				const requestPath = /** @type {string} */ (request.path);
 				const filename = /** @type {string} */ (basename(requestPath));
 				const filePath = resolver.join(requestPath, filename);
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					path: filePath,

diff --git a/lib/DescriptionFilePlugin.js b/lib/DescriptionFilePlugin.js
@@ -9,6 +9,7 @@ const DescriptionFileUtils = require("./DescriptionFileUtils");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class DescriptionFilePlugin {
 	/**
@@ -64,6 +65,7 @@ module.exports = class DescriptionFilePlugin {
 							}
 							const relativePath =
 								"." + path.substr(result.directory.length).replace(/\\/g, "/");
+							/** @type {ResolveRequest} */
 							const obj = {
 								...request,
 								descriptionFilePath: result.path,

diff --git a/lib/ExportsFieldPlugin.js b/lib/ExportsFieldPlugin.js
@@ -14,6 +14,7 @@ const { checkImportsExportsFieldTarget } = require("./util/path");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 /** @typedef {import("./util/entrypoints").ExportsField} ExportsField */
 /** @typedef {import("./util/entrypoints").FieldProcessor} FieldProcessor */
 
@@ -73,6 +74,7 @@ module.exports = class ExportsFieldPlugin {
 					);
 				}
 
+				/** @type {string[]} */
 				let paths;
 
 				try {
@@ -122,6 +124,7 @@ module.exports = class ExportsFieldPlugin {
 							return callback(error);
 						}
 
+						/** @type {ResolveRequest} */
 						const obj = {
 							...request,
 							request: undefined,

diff --git a/lib/ImportsFieldPlugin.js b/lib/ImportsFieldPlugin.js
@@ -76,6 +76,7 @@ module.exports = class ImportsFieldPlugin {
 					);
 				}
 
+				/** @type {string[]} */
 				let paths;
 
 				try {

diff --git a/lib/JoinRequestPartPlugin.js b/lib/JoinRequestPartPlugin.js
@@ -7,6 +7,7 @@
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 const namespaceStartCharCode = "@".charCodeAt(0);
 
@@ -38,16 +39,22 @@ module.exports = class JoinRequestPartPlugin {
 						i = req.indexOf("/", i + 1);
 					}
 
-					let moduleName, remainingRequest, fullySpecified;
+					/** @type {string} */
+					let moduleName;
+					/** @type {string} */
+					let remainingRequest;
+					/** @type {boolean} */
+					let fullySpecified;
 					if (i < 0) {
 						moduleName = req;
 						remainingRequest = ".";
 						fullySpecified = false;
 					} else {
 						moduleName = req.slice(0, i);
 						remainingRequest = "." + req.slice(i);
-						fullySpecified = request.fullySpecified;
+						fullySpecified = /** @type {boolean} */ (request.fullySpecified);
 					}
+					/** @type {ResolveRequest} */
 					const obj = {
 						...request,
 						path: resolver.join(

diff --git a/lib/JoinRequestPlugin.js b/lib/JoinRequestPlugin.js
@@ -7,6 +7,7 @@
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class JoinRequestPlugin {
 	/**
@@ -29,6 +30,7 @@ module.exports = class JoinRequestPlugin {
 			.tapAsync("JoinRequestPlugin", (request, resolveContext, callback) => {
 				const requestPath = /** @type {string} */ (request.path);
 				const requestRequest = /** @type {string} */ (request.request);
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					path: resolver.join(requestPath, requestRequest),

diff --git a/lib/MainFieldPlugin.js b/lib/MainFieldPlugin.js
@@ -10,6 +10,7 @@ const DescriptionFileUtils = require("./DescriptionFileUtils");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 /** @typedef {{name: string|Array<string>, forceRelative: boolean}} MainFieldOptions */
 
 const alreadyTriedMainField = Symbol("alreadyTriedMainField");
@@ -42,6 +43,7 @@ module.exports = class MainFieldPlugin {
 				)
 					return callback();
 				const filename = path.basename(request.descriptionFilePath);
+				/** @type {string} */
 				let mainModule = DescriptionFileUtils.getField(
 					request.descriptionFileData,
 					this.options.name
@@ -57,11 +59,14 @@ module.exports = class MainFieldPlugin {
 				}
 				if (this.options.forceRelative && !/^\.\.?\//.test(mainModule))
 					mainModule = "./" + mainModule;
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					request: mainModule,
 					module: false,
 					directory: mainModule.endsWith("/"),
+					// TODO improve types for this
+					// @ts-ignore
 					[alreadyTriedMainField]: request.descriptionFilePath
 				};
 				return resolver.doResolve(

diff --git a/lib/ModulesInHierarchicalDirectoriesPlugin.js b/lib/ModulesInHierarchicalDirectoriesPlugin.js
@@ -10,6 +10,7 @@ const getPaths = require("./getPaths");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class ModulesInHierarchicalDirectoriesPlugin {
 	/**
@@ -48,6 +49,7 @@ module.exports = class ModulesInHierarchicalDirectoriesPlugin {
 						(addr, callback) => {
 							fs.stat(addr, (err, stat) => {
 								if (!err && stat && stat.isDirectory()) {
+									/** @type {ResolveRequest} */
 									const obj = {
 										...request,
 										path: addr,

diff --git a/lib/ModulesInRootPlugin.js b/lib/ModulesInRootPlugin.js
@@ -7,6 +7,7 @@
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class ModulesInRootPlugin {
 	/**
@@ -29,6 +30,7 @@ module.exports = class ModulesInRootPlugin {
 		resolver
 			.getHook(this.source)
 			.tapAsync("ModulesInRootPlugin", (request, resolveContext, callback) => {
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					path: this.path,

diff --git a/lib/SelfReferencePlugin.js b/lib/SelfReferencePlugin.js
@@ -9,6 +9,7 @@ const DescriptionFileUtils = require("./DescriptionFileUtils");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 const slashCode = "/".charCodeAt(0);
 
@@ -57,7 +58,7 @@ module.exports = class SelfReferencePlugin {
 						req.charCodeAt(name.length) === slashCode)
 				) {
 					const remainingRequest = `.${req.slice(name.length)}`;
-
+					/** @type {ResolveRequest} */
 					const obj = {
 						...request,
 						request: remainingRequest,

diff --git a/lib/SymlinkPlugin.js b/lib/SymlinkPlugin.js
@@ -11,6 +11,7 @@ const { getType, PathType } = require("./util/path");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class SymlinkPlugin {
 	/**
@@ -70,6 +71,7 @@ module.exports = class SymlinkPlugin {
 						const result = resultSegments.reduceRight((a, b) => {
 							return resolver.join(a, b);
 						});
+						/** @type {ResolveRequest} */
 						const obj = {
 							...request,
 							path: result

diff --git a/lib/UseFilePlugin.js b/lib/UseFilePlugin.js
@@ -7,6 +7,7 @@
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 
 module.exports = class UseFilePlugin {
 	/**
@@ -33,6 +34,8 @@ module.exports = class UseFilePlugin {
 					/** @type {string} */ (request.path),
 					this.filename
 				);
+
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
 					path: filePath,

diff --git a/lib/createInnerContext.js b/lib/createInnerContext.js
@@ -5,18 +5,21 @@
 
 "use strict";
 
-/** @typedef {import("./Resolver").ResolveContext} InnerContext */
+/** @typedef {import("./Resolver").ResolveContext} ResolveContext */
 
 /**
- * @param {import("./Resolver").ResolveContext} options options for inner context
+ * @param {ResolveContext} options options for inner context
  * @param {null|string} message message to log
- * @returns {InnerContext} inner context
+ * @returns {ResolveContext} inner context
  */
 module.exports = function createInnerContext(options, message) {
 	let messageReported = false;
 	let innerLog = undefined;
 	if (options.log) {
 		if (message) {
+			/**
+			 * @param {string} msg message
+			 */
 			innerLog = msg => {
 				if (!messageReported) {
 					/** @type {(function(string): void)} */

diff --git a/lib/forEachBail.js b/lib/forEachBail.js
@@ -5,11 +5,21 @@
 
 "use strict";
 
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
+
+/**
+ * @template T
+ * @param {T[]} array array
+ * @param {(item: T, callback: (err?: null|Error, result?: any) => void) => void} iterator iterator
+ * @param {(err?: null|Error, result?: ResolveRequest) => void} callback callback after all items are iterated
+ * @returns {void}
+ */
 module.exports = function forEachBail(array, iterator, callback) {
 	if (array.length === 0) return callback();
 
 	let i = 0;
 	const next = () => {
+		/** @type {boolean|undefined} */
 		let loop = undefined;
 		iterator(array[i++], (err, result) => {
 			if (err || result !== undefined || i >= array.length) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -76,6 +76,7 @@ module.exports = class ImportsFieldPlugin { @@
     					);
     				}
+    				/** @type {string[]} */
     				let paths;
     				try {
@@ Expand Down @@