Merge pull request #20755 from webpack/chore/avivkeller/type-safety

avivkeller · web-flow · commit 315f8a2c96f4 · 2026-04-02T09:26:40.000-04:00
chore(types): improve type safety
diff --git a/lib/Dependency.js b/lib/Dependency.js
@@ -87,7 +87,7 @@ const memoize = require("./util/memoize");
 
 /** @typedef {(moduleGraphConnection: ModuleGraphConnection, runtime: RuntimeSpec) => ConnectionState} GetConditionFn */
 
-const TRANSITIVE = Symbol("transitive");
+const TRANSITIVE = /** @type {symbol} */ (Symbol("transitive"));
 
 const getIgnoredModule = memoize(() => {
 	const RawModule = require("./RawModule");
diff --git a/lib/dependencies/CommonJsExportRequireDependency.js b/lib/dependencies/CommonJsExportRequireDependency.js
@@ -32,7 +32,9 @@ const processExportInfo = require("./processExportInfo");
 /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
 /** @typedef {import("./CommonJsDependencyHelpers").CommonJSDependencyBaseKeywords} CommonJSDependencyBaseKeywords */
 
-const idsSymbol = Symbol("CommonJsExportRequireDependency.ids");
+const idsSymbol = /** @type {symbol} */ (
+	Symbol("CommonJsExportRequireDependency.ids")
+);
 
 const EMPTY_OBJECT = {};
 
diff --git a/lib/dependencies/HarmonyExportImportedSpecifierDependency.js b/lib/dependencies/HarmonyExportImportedSpecifierDependency.js
@@ -64,7 +64,9 @@ const processExportInfo = require("./processExportInfo");
 
 const { ExportPresenceModes } = HarmonyImportDependency;
 
-const idsSymbol = Symbol("HarmonyExportImportedSpecifierDependency.ids");
+const idsSymbol = /** @type {symbol} */ (
+	Symbol("HarmonyExportImportedSpecifierDependency.ids")
+);
 
 class NormalReexportItem {
 	/**
diff --git a/lib/dependencies/HarmonyImportSpecifierDependency.js b/lib/dependencies/HarmonyImportSpecifierDependency.js
@@ -40,7 +40,9 @@ const { ImportPhaseUtils } = require("./ImportPhase");
 /** @typedef {HarmonyImportDependency.Ids} Ids */
 /** @typedef {import("./ImportPhase").ImportPhaseType} ImportPhaseType */
 
-const idsSymbol = Symbol("HarmonyImportSpecifierDependency.ids");
+const idsSymbol = /** @type {symbol} */ (
+	Symbol("HarmonyImportSpecifierDependency.ids")
+);
 
 const { ExportPresenceModes } = HarmonyImportDependency;
 
diff --git a/test/BenchmarkTestCases.benchmark.mjs b/test/BenchmarkTestCases.benchmark.mjs
@@ -18,10 +18,10 @@ import { Bench, hrtimeNow } from "tinybench";
 /** @typedef {import("tinybench").Task} TinybenchTask */
 /** @typedef {import("tinybench").Fn} Fn */
 /** @typedef {import("tinybench").FnOptions} FnOptions */
-/** @typedef {import("../types.d.ts")} Webpack */
-/** @typedef {import("../types.d.ts").Configuration} Configuration */
-/** @typedef {import("../types.d.ts").Stats} Stats */
-/** @typedef {import("../types.d.ts").Watching} Watching */
+/** @typedef {import("..")} Webpack */
+/** @typedef {import("..").Configuration} Configuration */
+/** @typedef {import("..").Stats} Stats */
+/** @typedef {import("..").Watching} Watching */
 
 /** @typedef {TinybenchTask & { collectBy?: string }} Task */
 
diff --git a/test/benchmarkCases/asset-modules-bytes/webpack.config.mjs b/test/benchmarkCases/asset-modules-bytes/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	module: {
diff --git a/test/benchmarkCases/asset-modules-inline/webpack.config.mjs b/test/benchmarkCases/asset-modules-inline/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	module: {
diff --git a/test/benchmarkCases/asset-modules-resource/webpack.config.mjs b/test/benchmarkCases/asset-modules-resource/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	module: {
diff --git a/test/benchmarkCases/asset-modules-source/webpack.config.mjs b/test/benchmarkCases/asset-modules-source/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	module: {
diff --git a/test/benchmarkCases/cache-filesystem/webpack.config.mjs b/test/benchmarkCases/cache-filesystem/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	cache: {
diff --git a/test/benchmarkCases/concatenate-modules/webpack.config.mjs b/test/benchmarkCases/concatenate-modules/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	optimization: {
diff --git a/test/benchmarkCases/context-commonjs/webpack.config.mjs b/test/benchmarkCases/context-commonjs/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/context-esm/webpack.config.mjs b/test/benchmarkCases/context-esm/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/css-modules/webpack.config.mjs b/test/benchmarkCases/css-modules/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	target: "web",
diff --git a/test/benchmarkCases/devtool-eval-source-map/webpack.config.mjs b/test/benchmarkCases/devtool-eval-source-map/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	devtool: "eval-source-map"
diff --git a/test/benchmarkCases/devtool-eval/webpack.config.mjs b/test/benchmarkCases/devtool-eval/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	devtool: "eval"
diff --git a/test/benchmarkCases/devtool-source-map/webpack.config.mjs b/test/benchmarkCases/devtool-source-map/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	devtool: "source-map"
diff --git a/test/benchmarkCases/future-defaults/webpack.config.mjs b/test/benchmarkCases/future-defaults/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	experiments: {
diff --git a/test/benchmarkCases/json-modules/webpack.config.mjs b/test/benchmarkCases/json-modules/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/lodash/webpack.config.mjs b/test/benchmarkCases/lodash/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/many-chunks-commonjs/webpack.config.mjs b/test/benchmarkCases/many-chunks-commonjs/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/many-chunks-esm/webpack.config.mjs b/test/benchmarkCases/many-chunks-esm/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/many-modules-commonjs/webpack.config.mjs b/test/benchmarkCases/many-modules-commonjs/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/many-modules-esm/webpack.config.mjs b/test/benchmarkCases/many-modules-esm/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/react/webpack.config.mjs b/test/benchmarkCases/react/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/side-effects-reexport/webpack.config.mjs b/test/benchmarkCases/side-effects-reexport/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	devtool: false,
 	target: "web",
diff --git a/test/benchmarkCases/three-long/webpack.config.mjs b/test/benchmarkCases/three-long/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index"
 };
diff --git a/test/benchmarkCases/typescript-long-on-schedule/webpack.config.mjs b/test/benchmarkCases/typescript-long-on-schedule/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	target: "node",
diff --git a/test/benchmarkCases/wasm-modules-async/webpack.config.mjs b/test/benchmarkCases/wasm-modules-async/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	experiments: {
diff --git a/test/benchmarkCases/wasm-modules-sync/webpack.config.mjs b/test/benchmarkCases/wasm-modules-sync/webpack.config.mjs
@@ -1,4 +1,4 @@
-/** @type {import("../../../types.d.ts").Configuration} */
+/** @type {import("../../..").Configuration} */
 export default {
 	entry: "./index",
 	experiments: {
diff --git a/tsconfig.types.benchmark.json b/tsconfig.types.benchmark.json
@@ -1,16 +1,8 @@
 {
   "extends": "./tsconfig",
   "compilerOptions": {
-    "target": "es2022",
-    "module": "nodenext",
-    "lib": [
-      "es2024",
-      "ESNext.Array",
-      "ESNext.Collection",
-      "ESNext.Iterator",
-      "dom"
-    ],
-    "moduleResolution": "node16"
+    "module": "es2022",
+    "moduleResolution": "bundler"
   },
   "include": [
     "test/*.benchmark.mjs",
diff --git a/types.d.ts b/types.d.ts
@@ -3429,7 +3429,7 @@ declare class ConstDependency extends NullDependency {
 	static NO_EXPORTS_REFERENCED: string[][];
 	static EXPORTS_OBJECT_REFERENCED: string[][];
 	static isLowPriorityDependency(dependency: Dependency): boolean;
-	static TRANSITIVE: typeof TRANSITIVE;
+	static TRANSITIVE: symbol;
 }
 declare class ConstDependencyTemplate extends NullDependencyTemplate {
 	constructor();
@@ -4159,7 +4159,7 @@ declare class Dependency {
 	): void;
 	getContext(): undefined | string;
 	getResourceIdentifier(): null | string;
-	couldAffectReferencingModule(): boolean | typeof TRANSITIVE;
+	couldAffectReferencingModule(): boolean | symbol;
 
 	/**
 	 * Returns the referenced module and export
@@ -4219,7 +4219,7 @@ declare class Dependency {
 	static NO_EXPORTS_REFERENCED: string[][];
 	static EXPORTS_OBJECT_REFERENCED: string[][];
 	static isLowPriorityDependency(dependency: Dependency): boolean;
-	static TRANSITIVE: typeof TRANSITIVE;
+	static TRANSITIVE: symbol;
 }
 declare interface DependencyConstructor {
 	new (...args: any[]): Dependency;
@@ -6634,7 +6634,7 @@ declare class HarmonyImportDependency extends ModuleDependency {
 	static NO_EXPORTS_REFERENCED: string[][];
 	static EXPORTS_OBJECT_REFERENCED: string[][];
 	static isLowPriorityDependency(dependency: Dependency): boolean;
-	static TRANSITIVE: typeof TRANSITIVE;
+	static TRANSITIVE: symbol;
 }
 declare class HarmonyImportDependencyTemplate extends DependencyTemplate {
 	constructor();
@@ -10586,14 +10586,7 @@ declare interface MergeDuplicateChunksPluginOptions {
 	 */
 	stage?: number;
 }
-type Meta = KnownMeta &
-	Record<
-		| typeof idsSymbolCommonJsExportRequireDependency
-		| typeof idsSymbolHarmonyImportSpecifierDependency
-		| typeof idsSymbolHarmonyExportImportedSpecifierDependency,
-		string[]
-	> &
-	Record<string, any>;
+type Meta = KnownMeta & Record<symbol, string[]> & Record<string, any>;
 declare class MinChunkSizePlugin {
 	constructor(options: MinChunkSizePluginOptions);
 	options: MinChunkSizePluginOptions;
@@ -10882,7 +10875,7 @@ declare class ModuleDependency extends Dependency {
 	static NO_EXPORTS_REFERENCED: string[][];
 	static EXPORTS_OBJECT_REFERENCED: string[][];
 	static isLowPriorityDependency(dependency: Dependency): boolean;
-	static TRANSITIVE: typeof TRANSITIVE;
+	static TRANSITIVE: symbol;
 }
 declare class ModuleExternalInitFragment extends InitFragment<GenerateContext> {
 	constructor(
@@ -12526,7 +12519,7 @@ declare class NullDependency extends Dependency {
 	static NO_EXPORTS_REFERENCED: string[][];
 	static EXPORTS_OBJECT_REFERENCED: string[][];
 	static isLowPriorityDependency(dependency: Dependency): boolean;
-	static TRANSITIVE: typeof TRANSITIVE;
+	static TRANSITIVE: symbol;
 }
 declare class NullDependencyTemplate extends DependencyTemplate {
 	constructor();
@@ -18673,7 +18666,6 @@ declare interface SyntheticDependencyLocation {
 	index?: number;
 }
 declare const TOMBSTONE: unique symbol;
-declare const TRANSITIVE: unique symbol;
 declare const TRANSITIVE_ONLY: unique symbol;
 declare interface TagInfo {
 	tag: symbol;
@@ -20444,9 +20436,6 @@ declare namespace exports {
 		LoaderContext
 	};
 }
-declare const idsSymbolCommonJsExportRequireDependency: unique symbol;
-declare const idsSymbolHarmonyExportImportedSpecifierDependency: unique symbol;
-declare const idsSymbolHarmonyImportSpecifierDependency: unique symbol;
 declare const topLevelSymbolTag: unique symbol;
 
 export = exports;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/** @type {import("../../../types.d.ts").Configuration} */`
	`1`	`+/** @type {import("../../..").Configuration} */`
`2`	`2`	`export default {`
`3`	`3`	`entry: "./index",`
`4`	`4`	`module: {`