Merge pull request #381 from webpack/refactor-types

refactor: types
webpack · May 24, 2023 · 617b37a · 617b37a
2 parents 24a4279 + 76b2c9e
commit 617b37a
Show file tree

Hide file tree

Showing 62 changed files with 1,453 additions and 964 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,7 +14,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 16.x
           cache: yarn
       - run: yarn --frozen-lockfile
       - run: yarn lint
@@ -23,7 +23,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [10.x, 12.x, 14.x, 16.x, 17.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x, 20.x]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -32,8 +32,14 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: yarn
+      - name: Install dependencies
+        run: |
+          yarn upgrade typescript@^4 --ignore-engines
+          yarn --frozen-lockfile
+        if: matrix.node-version == '10.x'
       - name: Install dependencies
         run: yarn --frozen-lockfile
+        if: matrix.node-version != '10.x'
       - name: Run tests with coverage
         run: npm run test:coverage -- --ci
       - if: ${{ matrix.os != 'windows-latest' }}

diff --git a/declarations.d.ts b/declarations.d.ts
diff --git a/lib/AliasFieldPlugin.js b/lib/AliasFieldPlugin.js
@@ -9,6 +9,7 @@ const DescriptionFileUtils = require("./DescriptionFileUtils");
 const getInnerRequest = require("./getInnerRequest");
 
 /** @typedef {import("./Resolver")} Resolver */
+/** @typedef {import("./Resolver").JsonPrimitive} JsonPrimitive */
 /** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
 
@@ -49,13 +50,18 @@ module.exports = class AliasFieldPlugin {
 						);
 					return callback();
 				}
+				/** @type {JsonPrimitive | undefined} */
 				const data = Object.prototype.hasOwnProperty.call(
 					fieldData,
 					innerRequest
 				)
-					? fieldData[innerRequest]
+					? /** @type {{[Key in string]: JsonPrimitive}} */ (fieldData)[
+							innerRequest
+					  ]
 					: innerRequest.startsWith("./")
-					? fieldData[innerRequest.slice(2)]
+					? /** @type {{[Key in string]: JsonPrimitive}} */ (fieldData)[
+							innerRequest.slice(2)
+					  ]
 					: undefined;
 				if (data === innerRequest) return callback();
 				if (data === undefined) return callback();
@@ -71,10 +77,11 @@ module.exports = class AliasFieldPlugin {
 					}
 					return callback(null, ignoreObj);
 				}
+				/** @type {ResolveRequest} */
 				const obj = {
 					...request,
-					path: request.descriptionFileRoot,
-					request: data,
+					path: /** @type {string} */ (request.descriptionFileRoot),
+					request: /** @type {string} */ (data),
 					fullySpecified: false
 				};
 				resolver.doResolve(
@@ -85,7 +92,7 @@ module.exports = class AliasFieldPlugin {
 						" with mapping '" +
 						innerRequest +
 						"' to '" +
-						data +
+						/** @type {string} */ (data) +
 						"'",
 					resolveContext,
 					(err, result) => {

diff --git a/lib/AliasPlugin.js b/lib/AliasPlugin.js
@@ -11,7 +11,8 @@ const { PathType, getType } = require("./util/path");
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
-/** @typedef {{alias: string|Array<string>|false, name: string, onlyModule?: boolean}} AliasOption */
+/** @typedef {string | Array<string> | false} Alias */
+/** @typedef {{alias: Alias, name: string, onlyModule?: boolean}} AliasOption */
 
 module.exports = class AliasPlugin {
 	/**
@@ -31,13 +32,22 @@ module.exports = class AliasPlugin {
 	 */
 	apply(resolver) {
 		const target = resolver.ensureHook(this.target);
+		/**
+		 * @param {string} maybeAbsolutePath path
+		 * @returns {null|string} absolute path with slash ending
+		 */
 		const getAbsolutePathWithSlashEnding = maybeAbsolutePath => {
 			const type = getType(maybeAbsolutePath);
 			if (type === PathType.AbsolutePosix || type === PathType.AbsoluteWin) {
 				return resolver.join(maybeAbsolutePath, "_").slice(0, -1);
 			}
 			return null;
 		};
+		/**
+		 * @param {string} path path
+		 * @param {string} maybeSubPath sub path
+		 * @returns {boolean} true, if path is sub path
+		 */
 		const isSubPath = (path, maybeSubPath) => {
 			const absolutePath = getAbsolutePathWithSlashEnding(maybeSubPath);
 			if (!absolutePath) return false;
@@ -51,6 +61,7 @@ module.exports = class AliasPlugin {
 				forEachBail(
 					this.options,
 					(item, callback) => {
+						/** @type {boolean} */
 						let shouldStop = false;
 						if (
 							innerRequest === item.name ||
@@ -59,7 +70,13 @@ module.exports = class AliasPlugin {
 									? innerRequest.startsWith(`${item.name}/`)
 									: isSubPath(innerRequest, item.name)))
 						) {
+							/** @type {string} */
 							const remainingRequest = innerRequest.slice(item.name.length);
+							/**
+							 * @param {Alias} alias alias
+							 * @param {(err?: null|Error, result?: null|ResolveRequest) => void} callback callback
+							 * @returns {void}
+							 */
 							const resolveWithAlias = (alias, callback) => {
 								if (alias === false) {
 									/** @type {ResolveRequest} */
@@ -79,6 +96,7 @@ module.exports = class AliasPlugin {
 								) {
 									shouldStop = true;
 									const newRequestStr = alias + remainingRequest;
+									/** @type {ResolveRequest} */
 									const obj = {
 										...request,
 										request: newRequestStr,
@@ -104,6 +122,11 @@ module.exports = class AliasPlugin {
 								}
 								return callback();
 							};
+							/**
+							 * @param {null|Error} [err] error
+							 * @param {null|ResolveRequest} [result] result
+							 * @returns {void}
+							 */
 							const stoppingCallback = (err, result) => {
 								if (err) return callback(err);
 

diff --git a/lib/AppendPlugin.js b/lib/AppendPlugin.js
@@ -6,6 +6,7 @@
 "use strict";
 
 /** @typedef {import("./Resolver")} Resolver */
+/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
 
 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,