@flint.fyi/ts 0.14.1 → 0.14.3

package/lib/rules/generatorFunctionYields.test.js

@@ -0,0 +1,151 @@
+import rule from "./generatorFunctionYields.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+function* emptyGenerator() {
+    console.log("No yield here");
+}
+`,
+            snapshot: `
+function* emptyGenerator() {
+        ~
+        Generator functions must contain at least one yield expression to produce values.
+    console.log("No yield here");
+}
+`,
+        },
+        {
+            code: `
+const generator = function* () {
+    return 42;
+};
+`,
+            snapshot: `
+const generator = function* () {
+                          ~
+                          Generator functions must contain at least one yield expression to produce values.
+    return 42;
+};
+`,
+        },
+        {
+            code: `
+class MyClass {
+    *generatorMethod() {
+        this.doSomething();
+    }
+}
+`,
+            snapshot: `
+class MyClass {
+    *generatorMethod() {
+    ~
+    Generator functions must contain at least one yield expression to produce values.
+        this.doSomething();
+    }
+}
+`,
+        },
+        {
+            code: `
+function* generatorWithNestedFunction() {
+    function inner() {
+        yield 42;
+    }
+}
+`,
+            snapshot: `
+function* generatorWithNestedFunction() {
+        ~
+        Generator functions must contain at least one yield expression to produce values.
+    function inner() {
+        yield 42;
+    }
+}
+`,
+        },
+        {
+            code: `
+function* generatorWithNestedGeneratorFunction() {
+    function* inner() {
+        yield 42;
+    }
+}
+`,
+            snapshot: `
+function* generatorWithNestedGeneratorFunction() {
+        ~
+        Generator functions must contain at least one yield expression to produce values.
+    function* inner() {
+        yield 42;
+    }
+}
+`,
+        },
+    ],
+    valid: [
+        `
+function* validGenerator() {
+    yield 1;
+}
+`,
+        `
+function* validGeneratorMultiple() {
+    yield 1;
+    yield 2;
+    yield 3;
+}
+`,
+        `
+const generator = function* () {
+    yield 42;
+};
+`,
+        `
+class MyClass {
+    *generatorMethod() {
+        yield this.value;
+    }
+}
+`,
+        `
+function* conditionalYield(condition: boolean) {
+    if (condition) {
+        yield 1;
+    }
+}
+`,
+        `
+function* yieldInLoop() {
+    for (let i = 0; i < 10; i++) {
+        yield i;
+    }
+}
+`,
+        `
+function* yieldDelegate() {
+    yield* [1, 2, 3];
+}
+`,
+        `
+function regularFunction() {
+    return 42;
+}
+`,
+        `
+const arrow = () => {
+    return 42;
+};
+`,
+        `
+function* generatorWithNestedGenerator() {
+    yield 1;
+    function* inner() {
+        yield 2;
+    }
+}
+`,
+    ],
+});

package/lib/rules/globalAssignments.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports attempting to assign to read-only global variables such as undefined, NaN, Infinity, Object, etc.";
+    readonly id: "globalAssignments";
+    readonly preset: "untyped";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "noGlobalAssign", undefined>;
+export default _default;

package/lib/rules/globalAssignments.js

@@ -0,0 +1,59 @@
+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/lib/rules/globalAssignments.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/rules/globalAssignments.test.js

@@ -0,0 +1,215 @@
+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/lib/rules/globalObjectCalls.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports calling global objects like Math, JSON, or Reflect as functions.";
+    readonly id: "globalObjectCalls";
+    readonly preset: "untyped";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "noGlobalObjectCall", undefined>;
+export default _default;

package/lib/rules/globalObjectCalls.js

@@ -0,0 +1,43 @@
+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, name) {
+            context.report({
+                data: { name },
+                message: "noGlobalObjectCall",
+                range: getTSNodeRange(expression, context.sourceFile),
+            });
+        }
+        function checkNode({ expression }) {
+            if (ts.isIdentifier(expression) && globalObjects.has(expression.text)) {
+                reportGlobalObjectCall(expression, expression.text);
+            }
+        }
+        return {
+            visitors: {
+                CallExpression: checkNode,
+                NewExpression: checkNode,
+            },
+        };
+    },
+});

package/lib/rules/globalObjectCalls.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/rules/globalObjectCalls.test.js

@@ -0,0 +1,93 @@
+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/lib/rules/negativeZeroComparisons.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports comparisons with -0 that may not behave as expected.";
+    readonly id: "negativeZeroComparisons";
+    readonly preset: "logical";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "unexpectedNegativeZeroComparison", undefined>;
+export default _default;

package/lib/rules/negativeZeroComparisons.js

@@ -0,0 +1,83 @@
+import * as ts from "typescript";
+import { typescriptLanguage } from "../language.js";
+const comparisonOperators = new Set([
+    ts.SyntaxKind.EqualsEqualsEqualsToken,
+    ts.SyntaxKind.EqualsEqualsToken,
+    ts.SyntaxKind.ExclamationEqualsEqualsToken,
+    ts.SyntaxKind.ExclamationEqualsToken,
+    ts.SyntaxKind.GreaterThanEqualsToken,
+    ts.SyntaxKind.GreaterThanToken,
+    ts.SyntaxKind.LessThanEqualsToken,
+    ts.SyntaxKind.LessThanToken,
+]);
+function isEqualityOperator(operator) {
+    return (operator === "===" ||
+        operator === "==" ||
+        operator === "!==" ||
+        operator === "!=");
+}
+function isNegatedEqualityOperator(operator) {
+    return operator === "!==" || operator === "!=";
+}
+function isNegativeZero(node) {
+    return (ts.isPrefixUnaryExpression(node) &&
+        node.operator === ts.SyntaxKind.MinusToken &&
+        ts.isNumericLiteral(node.operand) &&
+        node.operand.text === "0");
+}
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports comparisons with -0 that may not behave as expected.",
+        id: "negativeZeroComparisons",
+        preset: "logical",
+    },
+    messages: {
+        unexpectedNegativeZeroComparison: {
+            primary: "Comparisons with -0 using {{ operator }} do not distinguish between -0 and +0.",
+            secondary: [
+                "In JavaScript, -0 and +0 are considered equal when using comparison operators like === or ==, even though they are distinct values.",
+                "To properly check for -0, use `Object.is(value, -0)` which correctly distinguishes between -0 and +0.",
+            ],
+            suggestions: ["Use `Object.is()` to reliably check if a value is -0."],
+        },
+    },
+    setup(context) {
+        function generateObjectIsText(node, isNegated) {
+            const leftText = node.left.getText(context.sourceFile);
+            const rightText = node.right.getText(context.sourceFile);
+            const objectIsCall = `Object.is(${leftText}, ${rightText})`;
+            return isNegated ? `!${objectIsCall}` : objectIsCall;
+        }
+        return {
+            visitors: {
+                BinaryExpression: (node) => {
+                    if (!comparisonOperators.has(node.operatorToken.kind) ||
+                        (!isNegativeZero(node.left) && !isNegativeZero(node.right))) {
+                        return;
+                    }
+                    const operator = node.operatorToken.getText(context.sourceFile);
+                    const range = {
+                        begin: node.getStart(context.sourceFile),
+                        end: node.getEnd(),
+                    };
+                    context.report({
+                        data: {
+                            operator,
+                        },
+                        message: "unexpectedNegativeZeroComparison",
+                        range,
+                        suggestions: isEqualityOperator(operator)
+                            ? [
+                                {
+                                    id: "useObjectIs",
+                                    range,
+                                    text: generateObjectIsText(node, isNegatedEqualityOperator(operator)),
+                                },
+                            ]
+                            : undefined,
+                    });
+                },
+            },
+        };
+    },
+});

package/lib/rules/negativeZeroComparisons.test.d.ts

@@ -0,0 +1 @@
+export {};