prefer-global-this: Fix auto-fix for typeof window (#2501)

axetroy · fisker · web-flow · commit b95dc12f92fa · 2025-02-17T22:56:25.000+07:00
Co-authored-by: fisker Cheung &lt;lionkay@gmail.com&gt;
diff --git a/rules/prefer-global-this.js b/rules/prefer-global-this.js
@@ -1,6 +1,6 @@
 const MESSAGE_ID_ERROR = 'prefer-global-this/error';
 const messages = {
-	[MESSAGE_ID_ERROR]: 'Prefer `globalThis` over `{{value}}`.',
+	[MESSAGE_ID_ERROR]: 'Prefer `{{replacement}}` over `{{value}}`.',
 };
 
 const globalIdentifier = new Set([
@@ -188,11 +188,16 @@ const create = context => ({
 				continue;
 			}
 
+			// Skip the fix for `typeof window` and `typeof self`
+			const isTypeofLegacyGlobal = identifier.parent.type === 'UnaryExpression' && identifier.parent.operator === 'typeof' && identifier.parent.argument === identifier;
+
+			const replacement = isTypeofLegacyGlobal ? 'globalThis.' + identifier.name : 'globalThis';
+
 			yield {
 				node: identifier,
 				messageId: MESSAGE_ID_ERROR,
-				data: {value: identifier.name},
-				fix: fixer => fixer.replaceText(identifier, 'globalThis'),
+				data: {replacement, value: identifier.name},
+				fix: fixer => fixer.replaceText(identifier, replacement),
 			};
 		}
 	},
diff --git a/test/prefer-global-this.js b/test/prefer-global-this.js
@@ -168,6 +168,12 @@ test.snapshot({
 		'[window.foo] = []',
 		'foo[window]',
 		'foo[window.foo]',
+		'typeof window !== "undefined"',
+		'typeof self !== "undefined"',
+		'typeof global !== "undefined"',
+		'typeof window.something === "function"',
+		'typeof self.something === "function"',
+		'typeof global.something === "function"',
 	],
 });
 
diff --git a/test/snapshots/prefer-global-this.js.md b/test/snapshots/prefer-global-this.js.md
@@ -1172,6 +1172,132 @@ Generated by [AVA](https://avajs.dev).
         |     ^^^^^^ Prefer \`globalThis\` over \`window\`.␊
     `
 
+## invalid(51): typeof window !== "undefined"
+
+> Input
+
+    `␊
+      1 | typeof window !== "undefined"␊
+    `
+
+> Output
+
+    `␊
+      1 | typeof globalThis.window !== "undefined"␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | typeof window !== "undefined"␊
+        |        ^^^^^^ Prefer \`globalThis.window\` over \`window\`.␊
+    `
+
+## invalid(52): typeof self !== "undefined"
+
+> Input
+
+    `␊
+      1 | typeof self !== "undefined"␊
+    `
+
+> Output
+
+    `␊
+      1 | typeof globalThis.self !== "undefined"␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | typeof self !== "undefined"␊
+        |        ^^^^ Prefer \`globalThis.self\` over \`self\`.␊
+    `
+
+## invalid(53): typeof global !== "undefined"
+
+> Input
+
+    `␊
+      1 | typeof global !== "undefined"␊
+    `
+
+> Output
+
+    `␊
+      1 | typeof globalThis.global !== "undefined"␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | typeof global !== "undefined"␊
+        |        ^^^^^^ Prefer \`globalThis.global\` over \`global\`.␊
+    `
+
+## invalid(54): typeof window.something === "function"
+
+> Input
+
+    `␊
+      1 | typeof window.something === "function"␊
+    `
+
+> Output
+
+    `␊
+      1 | typeof globalThis.something === "function"␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | typeof window.something === "function"␊
+        |        ^^^^^^ Prefer \`globalThis\` over \`window\`.␊
+    `
+
+## invalid(55): typeof self.something === "function"
+
+> Input
+
+    `␊
+      1 | typeof self.something === "function"␊
+    `
+
+> Output
+
+    `␊
+      1 | typeof globalThis.something === "function"␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | typeof self.something === "function"␊
+        |        ^^^^ Prefer \`globalThis\` over \`self\`.␊
+    `
+
+## invalid(56): typeof global.something === "function"
+
+> Input
+
+    `␊
+      1 | typeof global.something === "function"␊
+    `
+
+> Output
+
+    `␊
+      1 | typeof globalThis.something === "function"␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | typeof global.something === "function"␊
+        |        ^^^^^^ Prefer \`globalThis\` over \`global\`.␊
+    `
+
 ## invalid(1): global.global_did_not_declare_in_language_options
 
 > Input
diff --git a/test/snapshots/prefer-global-this.js.snap b/test/snapshots/prefer-global-this.js.snap
