refactor: fix some types

alexander-akait · web-flow · commit 1f0ab08b11f4 · 2026-02-15T21:00:03.000+03:00
diff --git a/.changeset/huge-paws-juggle.md b/.changeset/huge-paws-juggle.md
@@ -0,0 +1,5 @@
+---
+"webpack": patch
+---
+
+Fix some types.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -28,6 +28,7 @@ updates:
     groups:
       dependencies:
         patterns:
+          - "*"
   - package-ecosystem: "gitsubmodule"
     directory: "/"
     schedule:
@@ -38,3 +39,4 @@ updates:
     groups:
       dependencies:
         patterns:
+          - "*"
diff --git a/examples/build-common.js b/examples/build-common.js
@@ -12,24 +12,31 @@ const tc = require("./template-common");
 
 const extraArgs = "";
 
-// @ts-expect-error we are touching global
-const targetArgs = global.NO_TARGET_ARGS
+/**
+ * @typedef {object} GlobalObj
+ * @property {boolean=} NO_TARGET_ARGS no target args flag
+ * @property {boolean=} NO_REASONS no stats reasons flag
+ * @property {boolean=} NO_STATS_OPTIONS no stats options flag
+ * @property {boolean=} NO_PUBLIC_PATH no public path flag
+ * @property {boolean=} STATS_COLORS no stats color flag
+ */
+
+const globalObj = /** @type {typeof globalThis & GlobalObj} */ (global);
+
+const targetArgs = globalObj
 	? ""
 	: "--entry ./example.js --output-filename output.js";
-// @ts-expect-error we are touching global
-const displayReasons = global.NO_REASONS
+const displayReasons = globalObj
 	? ""
 	: "--stats-reasons --stats-used-exports --stats-provided-exports";
-// @ts-expect-error we are touching global
-const statsArgs = global.NO_STATS_OPTIONS
+const statsArgs = globalObj
 	? ""
 	: "--stats-chunks  --stats-modules-space 99999 --stats-chunk-origins";
-// @ts-expect-error we are touching global
-const publicPathArgs = global.NO_PUBLIC_PATH
+const publicPathArgs = globalObj.NO_PUBLIC_PATH
 	? ""
 	: '--output-public-path "dist/"';
-// @ts-expect-error we are touching global
-const statsColorsArg = global.STATS_COLORS ? "" : "--no-color";
+const statsColorsArg = globalObj.STATS_COLORS ? "" : "--no-color";
+
 const commonArgs = `${statsColorsArg} ${statsArgs} ${publicPathArgs} ${extraArgs} ${targetArgs}`;
 
 let readme = fs.readFileSync(
diff --git a/examples/examples.js b/examples/examples.js
@@ -13,6 +13,7 @@ function findInFolder(folder, depth) {
 		return [folder];
 	} else if (depth > 0) {
 		const files = fs.readdirSync(folder);
+		/** @type {string[]} */
 		const results = [];
 		for (const file of files) {
 			const innerPath = path.join(folder, file);
diff --git a/examples/template-common.js b/examples/template-common.js
@@ -71,6 +71,11 @@ const replaceBase = (template) => {
 		.replace(/\.chunkhash\./g, ".[chunkhash].")
 		.replace(
 			runtimeModulesRegexp,
+			/**
+			 * @param {string} match match
+			 * @param {string} content content
+			 * @returns {string} new content
+			 */
 			(match, content) =>
 				"```\n\n<details><summary>" +
 				"<code>/* webpack runtime code */</code>" +
diff --git a/lib/CleanPlugin.js b/lib/CleanPlugin.js
@@ -369,6 +369,7 @@ class CleanPlugin {
 	/** @param {CleanOptions} options options */
 	constructor(options = {}) {
 		validate(options);
+		/** @type {CleanOptions & { dry: boolean }} */
 		this.options = { dry: false, ...options };
 	}
 
diff --git a/lib/ContextModule.js b/lib/ContextModule.js
@@ -119,6 +119,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 /** @typedef {Record<ModuleId, FakeMapType>} FakeMap */
 /** @typedef {Record<string, ModuleId>} UserRequestMap */
+/** @typedef {Record<ModuleId, ModuleId[]>} UserRequestsMap */
 
 class ContextModule extends Module {
 	/**
@@ -711,7 +712,7 @@ class ContextModule extends Module {
 	/**
 	 * @param {Dependency[]} dependencies all dependencies
 	 * @param {ChunkGraph} chunkGraph chunk graph
-	 * @returns {Map<string, ModuleId[] | undefined>} map with user requests
+	 * @returns {UserRequestsMap} map with user requests
 	 */
 	getModuleDeferredAsyncDepsMap(dependencies, chunkGraph) {
 		const moduleGraph = chunkGraph.moduleGraph;
@@ -726,6 +727,7 @@ class ContextModule extends Module {
 			)
 			.filter(Boolean)
 			.sort(comparator);
+		/** @type {UserRequestsMap} */
 		const map = Object.create(null);
 		for (const module of sortedModules) {
 			if (!(/** @type {BuildMeta} */ (module.buildMeta).async)) {
@@ -740,7 +742,7 @@ class ContextModule extends Module {
 	}
 
 	/**
-	 * @param {false | Map<string, ModuleId[] | undefined>} asyncDepsMap fake map
+	 * @param {false | UserRequestsMap} asyncDepsMap fake map
 	 * @returns {string} async deps map init statement
 	 */
 	getModuleDeferredAsyncDepsMapInitStatement(asyncDepsMap) {
diff --git a/lib/EnvironmentNotSupportAsyncWarning.js b/lib/EnvironmentNotSupportAsyncWarning.js
@@ -26,6 +26,7 @@ As a result, the code may not run as expected or may cause runtime errors.`;
 
 		/** @type {string} */
 		this.name = "EnvironmentNotSupportAsyncWarning";
+		/** @type {Module} */
 		this.module = module;
 	}
 
diff --git a/lib/EvalDevToolModulePlugin.js b/lib/EvalDevToolModulePlugin.js
@@ -43,8 +43,11 @@ class EvalDevToolModulePlugin {
 	 * @param {EvalDevToolModulePluginOptions=} options options
 	 */
 	constructor(options = {}) {
+		/** @type {DevtoolNamespace} */
 		this.namespace = options.namespace || "";
+		/** @type {string} */
 		this.sourceUrlComment = options.sourceUrlComment || "\n//# sourceURL=[url]";
+		/** @type {DevtoolModuleFilenameTemplate} */
 		this.moduleFilenameTemplate =
 			options.moduleFilenameTemplate ||
 			"webpack://[namespace]/[resourcePath]?[loaders]";
diff --git a/lib/EvalSourceMapDevToolPlugin.js b/lib/EvalSourceMapDevToolPlugin.js
@@ -17,10 +17,13 @@ const { makePathsAbsolute } = require("./util/identifier");
 
 /** @typedef {import("webpack-sources").RawSourceMap} RawSourceMap */
 /** @typedef {import("webpack-sources").Source} Source */
+/** @typedef {import("../declarations/WebpackOptions").DevtoolNamespace} DevtoolNamespace */
+/** @typedef {import("../declarations/WebpackOptions").DevtoolModuleFilenameTemplate} DevtoolModuleFilenameTemplate */
 /** @typedef {import("../declarations/plugins/SourceMapDevToolPlugin").SourceMapDevToolPluginOptions} SourceMapDevToolPluginOptions */
 /** @typedef {import("../declarations/plugins/SourceMapDevToolPlugin").Rules} Rules */
-/** @typedef {import("./ChunkGraph").ModuleId} ModuleId */
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./ChunkGraph").ModuleId} ModuleId */
+/** @typedef {import("./TemplatedPathPlugin").TemplatePath} TemplatePath */
 
 /** @type {WeakMap<Source, Source>} */
 const cache = new WeakMap();
@@ -51,14 +54,18 @@ class EvalSourceMapDevToolPlugin {
 		} else {
 			options = inputOptions;
 		}
+		/** @type {string} */
 		this.sourceMapComment =
 			options.append && typeof options.append !== "function"
 				? options.append
 				: "//# sourceURL=[module]\n//# sourceMappingURL=[url]";
+		/** @type {DevtoolModuleFilenameTemplate} */
 		this.moduleFilenameTemplate =
 			options.moduleFilenameTemplate ||
 			"webpack://[namespace]/[resource-path]?[hash]";
+		/** @type {DevtoolNamespace} */
 		this.namespace = options.namespace || "";
+		/** @type {SourceMapDevToolPluginOptions} */
 		this.options = options;
 	}
 
diff --git a/lib/ExternalModule.js b/lib/ExternalModule.js
@@ -995,15 +995,15 @@ class ExternalModule extends Module {
 				);
 				/** @type {CodeGenerationResultData} */
 				const data = new Map();
-				data.set("url", { javascript: request });
+				data.set("url", { javascript: /** @type {string} */ (request) });
 				return { sources, runtimeRequirements: RUNTIME_REQUIREMENTS, data };
 			}
 			case "css-url": {
 				/** @type {Sources} */
 				const sources = new Map();
 				/** @type {CodeGenerationResultData} */
 				const data = new Map();
-				data.set("url", { "css-url": request });
+				data.set("url", { "css-url": /** @type {string} */ (request) });
 				return { sources, runtimeRequirements: RUNTIME_REQUIREMENTS, data };
 			}
 			case "css-import": {
diff --git a/lib/Module.js b/lib/Module.js
@@ -104,11 +104,36 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {Set<string>} RuntimeRequirements */
 /** @typedef {ReadonlySet<string>} ReadOnlyRuntimeRequirements */
 
-/** @typedef {Map<"topLevelDeclarations", Set<string>> & Map<"chunkInitFragments", InitFragment<EXPECTED_ANY>[]>} KnownCodeGenerationResultDataForJavascriptModules */
-/** @typedef {Map<"url", { ["css-url"]: string }>} KnownCodeGenerationResultDataForCssModules */
-/** @typedef {Map<"filename", string> & Map<"assetInfo", AssetInfo> & Map<"fullContentHash", string> & Map<"url", { javascript: string }>} KnownCodeGenerationResultDataForAssetModules */
-/** @typedef {Map<"share-init", [{ shareScope: string, initStage: number, init: string }]>} KnownCodeGenerationResultForSharing */
-/** @typedef {KnownCodeGenerationResultDataForJavascriptModules & KnownCodeGenerationResultDataForCssModules & KnownCodeGenerationResultDataForAssetModules & KnownCodeGenerationResultForSharing & Map<string, EXPECTED_ANY>} CodeGenerationResultData */
+/**
+ * @typedef {object} AllCodeGenerationSchemas
+ * @property {Set<string>} topLevelDeclarations top level declarations for javascript modules
+ * @property {InitFragment<EXPECTED_ANY>[]} chunkInitFragments chunk init fragments for javascript modules
+ * @property {{ javascript?: string, ["css-url"]?: string }} url url for css and javascript modules
+ * @property {string} filename a filename for asset modules
+ * @property {AssetInfo} assetInfo an asset info for asset modules
+ * @property {string} fullContentHash a full content hash for asset modules
+ * @property {[{ shareScope: string, initStage: number, init: string }]} share-init share-init for modules federation
+ */
+
+/* eslint-disable jsdoc/type-formatting */
+/**
+ * @template {string} K
+ * @typedef {K extends keyof AllCodeGenerationSchemas ? AllCodeGenerationSchemas[K] : EXPECTED_ANY} CodeGenValue
+ */
+/* eslint-enable jsdoc/type-formatting */
+
+/* eslint-disable jsdoc/require-template */
+/**
+ * @typedef {object} CodeGenMapOverloads
+ * @property {<K extends string>(key: K) => CodeGenValue<K> | undefined} get
+ * @property {<K extends string>(key: K, value: CodeGenValue<K>) => CodeGenerationResultData} set
+ * @property {<K extends string>(key: K) => boolean} has
+ * @property {<K extends string>(key: K) => boolean} delete
+ */
+
+/**
+ * @typedef {Omit<Map<string, EXPECTED_ANY>, "get" | "set" | "has" | "delete"> & CodeGenMapOverloads} CodeGenerationResultData
+ */
 
 /** @typedef {Map<SourceType, Source>} Sources */
 
diff --git a/lib/SourceMapDevToolModuleOptionsPlugin.js b/lib/SourceMapDevToolModuleOptionsPlugin.js
@@ -17,6 +17,7 @@ class SourceMapDevToolModuleOptionsPlugin {
 	 * @param {SourceMapDevToolPluginOptions=} options options
 	 */
 	constructor(options = {}) {
+		/** @type {SourceMapDevToolPluginOptions} */
 		this.options = options;
 	}
 
diff --git a/lib/SourceMapDevToolPlugin.js b/lib/SourceMapDevToolPlugin.js
@@ -19,6 +19,9 @@ const { makePathsAbsolute } = require("./util/identifier");
 
 /** @typedef {import("webpack-sources").MapOptions} MapOptions */
 /** @typedef {import("webpack-sources").Source} Source */
+/** @typedef {import("../declarations/WebpackOptions").DevtoolNamespace} DevtoolNamespace */
+/** @typedef {import("../declarations/WebpackOptions").DevtoolModuleFilenameTemplate} DevtoolModuleFilenameTemplate */
+/** @typedef {import("../declarations/WebpackOptions").DevtoolFallbackModuleFilenameTemplate} DevtoolFallbackModuleFilenameTemplate */
 /** @typedef {import("../declarations/plugins/SourceMapDevToolPlugin").SourceMapDevToolPluginOptions} SourceMapDevToolPluginOptions */
 /** @typedef {import("../declarations/plugins/SourceMapDevToolPlugin").Rules} Rules */
 /** @typedef {import("./CacheFacade").ItemCacheFacade} ItemCacheFacade */
@@ -140,19 +143,24 @@ class SourceMapDevToolPlugin {
 	constructor(options = {}) {
 		validate(options);
 
-		this.sourceMapFilename = /** @type {string | false} */ (options.filename);
-		/** @type {false | TemplatePath}} */
+		/** @type {undefined | null | false | string} */
+		this.sourceMapFilename = options.filename;
+		/** @type {false | TemplatePath} */
 		this.sourceMappingURLComment =
 			options.append === false
 				? false
 				: // eslint-disable-next-line no-useless-concat
 					options.append || "\n//# source" + "MappingURL=[url]";
+		/** @type {DevtoolModuleFilenameTemplate} */
 		this.moduleFilenameTemplate =
 			options.moduleFilenameTemplate || "webpack://[namespace]/[resourcePath]";
+		/** @type {DevtoolFallbackModuleFilenameTemplate} */
 		this.fallbackModuleFilenameTemplate =
 			options.fallbackModuleFilenameTemplate ||
 			"webpack://[namespace]/[resourcePath]?[hash]";
+		/** @type {DevtoolNamespace} */
 		this.namespace = options.namespace || "";
+		/** @type {SourceMapDevToolPluginOptions} */
 		this.options = options;
 	}
 
diff --git a/lib/asset/RawDataUrlModule.js b/lib/asset/RawDataUrlModule.js
@@ -42,9 +42,13 @@ class RawDataUrlModule extends Module {
 	 */
 	constructor(url, identifier, readableIdentifier) {
 		super(ASSET_MODULE_TYPE_RAW_DATA_URL, null);
+		/** @type {string} */
 		this.url = url;
+		/** @type {Buffer | undefined} */
 		this.urlBuffer = url ? Buffer.from(url) : undefined;
-		this.identifierStr = identifier || this.url;
+		/** @type {string} */
+		this.identifierStr = identifier;
+		/** @type {string} */
 		this.readableIdentifierStr = readableIdentifier || this.identifierStr;
 	}
 
diff --git a/lib/performance/AssetsOverSizeLimitWarning.js b/lib/performance/AssetsOverSizeLimitWarning.js
@@ -28,6 +28,7 @@ Assets: ${assetLists}`);
 
 		/** @type {string} */
 		this.name = "AssetsOverSizeLimitWarning";
+		/** @type {AssetDetails[]} */
 		this.assets = assetsOverSizeLimit;
 	}
 }
diff --git a/lib/performance/EntrypointsOverSizeLimitWarning.js b/lib/performance/EntrypointsOverSizeLimitWarning.js
@@ -31,6 +31,7 @@ Entrypoints:${entrypointList}\n`);
 
 		/** @type {string} */
 		this.name = "EntrypointsOverSizeLimitWarning";
+		/** @type {EntrypointDetails[]} */
 		this.entrypoints = entrypoints;
 	}
 }
diff --git a/lib/performance/SizeLimitsPlugin.js b/lib/performance/SizeLimitsPlugin.js
@@ -46,6 +46,7 @@ module.exports = class SizeLimitsPlugin {
 	 * @param {PerformanceOptions} options the plugin options
 	 */
 	constructor(options) {
+		/** @type {PerformanceOptions["hints"]} */
 		this.hints = options.hints;
 		/** @type {number | undefined} */
 		this.maxAssetSize = options.maxAssetSize;
diff --git a/package.json b/package.json
@@ -109,7 +109,7 @@
     "tapable": "^2.3.0",
     "terser-webpack-plugin": "^5.3.16",
     "watchpack": "^2.5.1",
-    "webpack-sources": "^3.3.3"
+    "webpack-sources": "^3.3.4"
   },
   "devDependencies": {
     "@babel/core": "^7.27.1",
@@ -136,7 +136,7 @@
     "es5-ext": "^0.10.53",
     "es6-promise-polyfill": "^1.2.0",
     "eslint": "^9.39.2",
-    "eslint-config-webpack": "^4.9.1",
+    "eslint-config-webpack": "^4.9.3",
     "file-loader": "^6.0.0",
     "fork-ts-checker-webpack-plugin": "^9.0.2",
     "globals": "^17.0.0",
@@ -188,7 +188,7 @@
     "three": "^0.182.0",
     "tinybench": "^6.0.0",
     "toml": "^3.0.0",
-    "tooling": "webpack/tooling#v1.24.5",
+    "tooling": "webpack/tooling#v1.24.6",
     "ts-loader": "^9.5.4",
     "typescript": "^5.9.3",
     "unified": "^11.0.5",
diff --git a/types.d.ts b/types.d.ts
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"webpack": patch
 +---
++
 +Fix some types.
Original file line number	Diff line number	Diff line change
`@@ -369,6 +369,7 @@ class CleanPlugin {`
`369`	`369`	`/** @param {CleanOptions} options options */`
`370`	`370`	`constructor(options = {}) {`
`371`	`371`	`validate(options);`
	`372`	`+ /** @type {CleanOptions & { dry: boolean }} */`
`372`	`373`	`this.options = { dry: false, ...options };`
`373`	`374`	`}`
`374`	`375`
Original file line number	Diff line number	Diff line change
@@ -26,6 +26,7 @@ As a result, the code may not run as expected or may cause runtime errors.`;
`26`	`26`
`27`	`27`	`/** @type {string} */`
`28`	`28`	`this.name = "EnvironmentNotSupportAsyncWarning";`
	`29`	`+ /** @type {Module} */`
`29`	`30`	`this.module = module;`
`30`	`31`	`}`
`31`	`32`