@flint.fyi/ts 0.14.1 → 0.14.3

package/src/rules/globalAssignments.test.ts

@@ -0,0 +1,216 @@
+import rule from "./globalAssignments.js";
+import { ruleTester } from "./ruleTester.js";
+
+ruleTester.describe(rule, {
+	invalid: [
+		{
+			code: `
+undefined = 1;
+`,
+			snapshot: `
+undefined = 1;
+~~~~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+NaN = 42;
+`,
+			snapshot: `
+NaN = 42;
+~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Infinity = 100;
+`,
+			snapshot: `
+Infinity = 100;
+~~~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Object = null;
+`,
+			snapshot: `
+Object = null;
+~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Array = function() {};
+`,
+			snapshot: `
+Array = function() {};
+~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+String = "test";
+`,
+			snapshot: `
+String = "test";
+~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Number = 123;
+`,
+			snapshot: `
+Number = 123;
+~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Boolean = true;
+`,
+			snapshot: `
+Boolean = true;
+~~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Math = {};
+`,
+			snapshot: `
+Math = {};
+~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+JSON = null;
+`,
+			snapshot: `
+JSON = null;
+~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+window = {};
+`,
+			snapshot: `
+window = {};
+~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+undefined += 1;
+`,
+			snapshot: `
+undefined += 1;
+~~~~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+NaN *= 2;
+`,
+			snapshot: `
+NaN *= 2;
+~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+++undefined;
+`,
+			snapshot: `
+++undefined;
+  ~~~~~~~~~
+  Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+NaN++;
+`,
+			snapshot: `
+NaN++;
+~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+--Infinity;
+`,
+			snapshot: `
+--Infinity;
+  ~~~~~~~~
+  Read-only global variables should not be reassigned or modified.
+`,
+		},
+		{
+			code: `
+Object--;
+`,
+			snapshot: `
+Object--;
+~~~~~~
+Read-only global variables should not be reassigned or modified.
+`,
+		},
+	],
+	valid: [
+		`let undefined = 1;`,
+		`const NaN = 42;`,
+		`var Infinity = 100;`,
+		`function Object() {}`,
+		`let value = undefined;`,
+		`const result = NaN;`,
+		`if (value === undefined) {}`,
+		`const obj = { undefined: 1 };`,
+		`obj.undefined = 2;`,
+		`const custom = { NaN: 42 }; custom.NaN = 100;`,
+		`let myVar = 5; myVar = 10;`,
+		`const data = { value: 1 }; data.value = 2;`,
+		`let counter = 0; counter++;`,
+		`let index = 10; --index;`,
+		`
+function test() {
+    let undefined = 5;
+    undefined = 10;
+}
+`,
+		`
+const obj = {
+    undefined: 1,
+    NaN: 2,
+};
+obj.undefined = 5;
+`,
+		`
+const fn = (undefined: number) => {
+    undefined = 10;
+};
+`,
+		`
+function test(NaN: string) {
+    NaN = "updated";
+}
+`,
+	],
+});

package/src/rules/globalAssignments.ts

@@ -0,0 +1,67 @@
+import * as tsutils from "ts-api-utils";
+import * as ts from "typescript";
+
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+import { isGlobalVariable } from "../utils/isGlobalVariable.js";
+
+export default typescriptLanguage.createRule({
+	about: {
+		description:
+			"Reports attempting to assign to read-only global variables such as undefined, NaN, Infinity, Object, etc.",
+		id: "globalAssignments",
+		preset: "untyped",
+	},
+	messages: {
+		noGlobalAssign: {
+			primary:
+				"Read-only global variables should not be reassigned or modified.",
+			secondary: [
+				"Global variables like undefined, NaN, Infinity, and built-in objects like Object and Array are read-only and should not be modified.",
+				"Attempting to reassign these globals can lead to confusing behavior and potential bugs in your code.",
+				"In strict mode, reassigning these globals will throw a TypeError at runtime.",
+			],
+			suggestions: [
+				"Use a different variable name instead of shadowing or reassigning globals.",
+				"If you need a similar name, consider using a more specific name that doesn't conflict with global variables.",
+			],
+		},
+	},
+	setup(context) {
+		return {
+			visitors: {
+				BinaryExpression: (node) => {
+					if (
+						tsutils.isAssignmentKind(node.operatorToken.kind) &&
+						isGlobalVariable(node.left, context.typeChecker)
+					) {
+						context.report({
+							message: "noGlobalAssign",
+							range: getTSNodeRange(node.left, context.sourceFile),
+						});
+					}
+				},
+				PostfixUnaryExpression: (node) => {
+					if (isGlobalVariable(node.operand, context.typeChecker)) {
+						context.report({
+							message: "noGlobalAssign",
+							range: getTSNodeRange(node.operand, context.sourceFile),
+						});
+					}
+				},
+				PrefixUnaryExpression: (node) => {
+					if (
+						(node.operator === ts.SyntaxKind.PlusPlusToken ||
+							node.operator === ts.SyntaxKind.MinusMinusToken) &&
+						isGlobalVariable(node.operand, context.typeChecker)
+					) {
+						context.report({
+							message: "noGlobalAssign",
+							range: getTSNodeRange(node.operand, context.sourceFile),
+						});
+					}
+				},
+			},
+		};
+	},
+});

package/src/rules/globalObjectCalls.test.ts

@@ -0,0 +1,94 @@
+import rule from "./globalObjectCalls.js";
+import { ruleTester } from "./ruleTester.js";
+
+ruleTester.describe(rule, {
+	invalid: [
+		{
+			code: `
+const result = Math();
+`,
+			snapshot: `
+const result = Math();
+               ~~~~
+               Math is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const data = JSON();
+`,
+			snapshot: `
+const data = JSON();
+             ~~~~
+             JSON is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const reflected = Reflect();
+`,
+			snapshot: `
+const reflected = Reflect();
+                  ~~~~~~~
+                  Reflect is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const atomic = Atomics();
+`,
+			snapshot: `
+const atomic = Atomics();
+               ~~~~~~~
+               Atomics is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const instance = new Math();
+`,
+			snapshot: `
+const instance = new Math();
+                     ~~~~
+                     Math is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const instance = new JSON();
+`,
+			snapshot: `
+const instance = new JSON();
+                     ~~~~
+                     JSON is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const instance = new Reflect();
+`,
+			snapshot: `
+const instance = new Reflect();
+                     ~~~~~~~
+                     Reflect is not a function and cannot be called directly.
+`,
+		},
+		{
+			code: `
+const instance = new Atomics();
+`,
+			snapshot: `
+const instance = new Atomics();
+                     ~~~~~~~
+                     Atomics is not a function and cannot be called directly.
+`,
+		},
+	],
+	valid: [
+		`const value = Math.abs(-5);`,
+		`const parsed = JSON.parse("{}");`,
+		`const stringified = JSON.stringify({});`,
+		`const keys = Reflect.ownKeys({});`,
+		`const result = Atomics.add(buffer, 0, 1);`,
+	],
+});

package/src/rules/globalObjectCalls.ts

@@ -0,0 +1,52 @@
+import * as ts from "typescript";
+
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+
+const globalObjects = new Set(["Atomics", "JSON", "Math", "Reflect"]);
+
+export default typescriptLanguage.createRule({
+	about: {
+		description:
+			"Reports calling global objects like Math, JSON, or Reflect as functions.",
+		id: "globalObjectCalls",
+		preset: "untyped",
+	},
+	messages: {
+		noGlobalObjectCall: {
+			primary: "{{ name }} is not a function and cannot be called directly.",
+			secondary: [
+				"{{ name }} is a built-in global object that provides utility methods and properties.",
+				"It is not a constructor or function and cannot be called or instantiated.",
+			],
+			suggestions: [
+				"Use the static methods available on {{ name }} instead (e.g., {{ name }}.methodName()).",
+			],
+		},
+	},
+	setup(context) {
+		function reportGlobalObjectCall(
+			expression: ts.Expression,
+			name: string,
+		): void {
+			context.report({
+				data: { name },
+				message: "noGlobalObjectCall",
+				range: getTSNodeRange(expression, context.sourceFile),
+			});
+		}
+
+		function checkNode({ expression }: ts.CallExpression | ts.NewExpression) {
+			if (ts.isIdentifier(expression) && globalObjects.has(expression.text)) {
+				reportGlobalObjectCall(expression, expression.text);
+			}
+		}
+
+		return {
+			visitors: {
+				CallExpression: checkNode,
+				NewExpression: checkNode,
+			},
+		};
+	},
+});

package/src/rules/negativeZeroComparisons.test.ts

@@ -0,0 +1,210 @@
+import rule from "./negativeZeroComparisons.js";
+import { ruleTester } from "./ruleTester.js";
+
+ruleTester.describe(rule, {
+	invalid: [
+		{
+			code: `
+if (value === -0) {}
+`,
+			snapshot: `
+if (value === -0) {}
+    ~~~~~~~~~~~~
+    Comparisons with -0 using === do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+if (Object.is(value, -0)) {}
+`,
+				},
+			],
+		},
+		{
+			code: `
+if (-0 === value) {}
+`,
+			snapshot: `
+if (-0 === value) {}
+    ~~~~~~~~~~~~
+    Comparisons with -0 using === do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+if (Object.is(-0, value)) {}
+`,
+				},
+			],
+		},
+		{
+			code: `
+if (value == -0) {}
+`,
+			snapshot: `
+if (value == -0) {}
+    ~~~~~~~~~~~
+    Comparisons with -0 using == do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+if (Object.is(value, -0)) {}
+`,
+				},
+			],
+		},
+		{
+			code: `
+if (value !== -0) {}
+`,
+			snapshot: `
+if (value !== -0) {}
+    ~~~~~~~~~~~~
+    Comparisons with -0 using !== do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+if (!Object.is(value, -0)) {}
+`,
+				},
+			],
+		},
+		{
+			code: `
+if (value != -0) {}
+`,
+			snapshot: `
+if (value != -0) {}
+    ~~~~~~~~~~~
+    Comparisons with -0 using != do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+if (!Object.is(value, -0)) {}
+`,
+				},
+			],
+		},
+		{
+			code: `
+if (value < -0) {}
+`,
+			snapshot: `
+if (value < -0) {}
+    ~~~~~~~~~~
+    Comparisons with -0 using < do not distinguish between -0 and +0.
+`,
+		},
+		{
+			code: `
+if (value <= -0) {}
+`,
+			snapshot: `
+if (value <= -0) {}
+    ~~~~~~~~~~~
+    Comparisons with -0 using <= do not distinguish between -0 and +0.
+`,
+		},
+		{
+			code: `
+if (value > -0) {}
+`,
+			snapshot: `
+if (value > -0) {}
+    ~~~~~~~~~~
+    Comparisons with -0 using > do not distinguish between -0 and +0.
+`,
+		},
+		{
+			code: `
+if (value >= -0) {}
+`,
+			snapshot: `
+if (value >= -0) {}
+    ~~~~~~~~~~~
+    Comparisons with -0 using >= do not distinguish between -0 and +0.
+`,
+		},
+		{
+			code: `
+const result = value === -0 ? "negative zero" : "other";
+`,
+			snapshot: `
+const result = value === -0 ? "negative zero" : "other";
+               ~~~~~~~~~~~~
+               Comparisons with -0 using === do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+const result = Object.is(value, -0) ? "negative zero" : "other";
+`,
+				},
+			],
+		},
+		{
+			code: `
+while (value !== -0) {
+	value++;
+}
+`,
+			snapshot: `
+while (value !== -0) {
+       ~~~~~~~~~~~~
+       Comparisons with -0 using !== do not distinguish between -0 and +0.
+	value++;
+}
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+while (!Object.is(value, -0)) {
+	value++;
+}
+`,
+				},
+			],
+		},
+		{
+			code: `
+const isNegativeZero = value === -0;
+`,
+			snapshot: `
+const isNegativeZero = value === -0;
+                       ~~~~~~~~~~~~
+                       Comparisons with -0 using === do not distinguish between -0 and +0.
+`,
+			suggestions: [
+				{
+					id: "useObjectIs",
+					updated: `
+const isNegativeZero = Object.is(value, -0);
+`,
+				},
+			],
+		},
+	],
+	valid: [
+		`if (value === 0) {}`,
+		`if (value === -1) {}`,
+		`if (value === 1) {}`,
+		`if (Object.is(value, -0)) {}`,
+		`if (Object.is(-0, value)) {}`,
+		`const result = -0;`,
+		`const value = -0 + 1;`,
+		`const value = -0 * 2;`,
+		`const value = Math.abs(-0);`,
+		`const value = [-0, 0, 1];`,
+		`function test() { return -0; }`,
+	],
+});