@flint.fyi/ts 0.14.2 → 0.14.3

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 {};

package/lib/rules/negativeZeroComparisons.test.js

@@ -0,0 +1,209 @@
+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; }`,
+    ],
+});

package/lib/rules/newExpressions.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports standalone new expressions that don't use the constructed object.";
+    readonly id: "newExpressions";
+    readonly preset: "logical";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "noStandaloneNew", undefined>;
+export default _default;

package/lib/rules/newExpressions.js

@@ -0,0 +1,54 @@
+import * as ts from "typescript";
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports standalone new expressions that don't use the constructed object.",
+        id: "newExpressions",
+        preset: "logical",
+    },
+    messages: {
+        noStandaloneNew: {
+            primary: "Constructors should only be called when their return value is used.",
+            secondary: [
+                "Using `new` to construct an object but not storing or using the result is often a mistake or indicates unclear code intent.",
+                "If the constructor has side effects you want to trigger, it's better to make that explicit by calling a separate method rather than relying on constructor side effects.",
+            ],
+            suggestions: [
+                "If you need to use the constructed object, assign it to a variable or return it.",
+                "If you only need the constructor's side effects, consider refactoring to a function that makes the side effects explicit.",
+            ],
+        },
+    },
+    setup(context) {
+        function isStandaloneExpression(node) {
+            const parent = node.parent;
+            // If parent is an ExpressionStatement, it's standalone
+            if (parent.kind === ts.SyntaxKind.ExpressionStatement) {
+                return true;
+            }
+            // If parent is a comma expression, check recursively
+            if (ts.isBinaryExpression(parent) &&
+                parent.operatorToken.kind === ts.SyntaxKind.CommaToken) {
+                // If this is the last expression in the comma sequence, check if the parent is standalone
+                if (parent.right === node) {
+                    return isStandaloneExpression(parent);
+                }
+                return true;
+            }
+            return false;
+        }
+        return {
+            visitors: {
+                NewExpression: (node) => {
+                    if (isStandaloneExpression(node)) {
+                        context.report({
+                            message: "noStandaloneNew",
+                            range: getTSNodeRange(node.getChildAt(0, context.sourceFile), context.sourceFile),
+                        });
+                    }
+                },
+            },
+        };
+    },
+});

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

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

package/lib/rules/newExpressions.test.js

@@ -0,0 +1,79 @@
+import rule from "./newExpressions.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+new MyClass();
+`,
+            snapshot: `
+new MyClass();
+~~~
+Constructors should only be called when their return value is used.
+`,
+        },
+        {
+            code: `
+function process() {
+    new EventEmitter();
+}
+`,
+            snapshot: `
+function process() {
+    new EventEmitter();
+    ~~~
+    Constructors should only be called when their return value is used.
+}
+`,
+        },
+        {
+            code: `
+if (condition) {
+    new Logger();
+}
+`,
+            snapshot: `
+if (condition) {
+    new Logger();
+    ~~~
+    Constructors should only be called when their return value is used.
+}
+`,
+        },
+        {
+            code: `
+new DatabaseConnection(), processData();
+`,
+            snapshot: `
+new DatabaseConnection(), processData();
+~~~
+Constructors should only be called when their return value is used.
+`,
+        },
+        {
+            code: `
+someFunction(), new Queue();
+`,
+            snapshot: `
+someFunction(), new Queue();
+                ~~~
+                Constructors should only be called when their return value is used.
+`,
+        },
+    ],
+    valid: [
+        `const instance = new MyClass();`,
+        `let value = new MyClass();`,
+        `const result = condition ? new MyClass() : new OtherClass();`,
+        `return new MyClass();`,
+        `throw new Error("message");`,
+        `function create() { return new MyClass(); }`,
+        `const array = [new MyClass(), new OtherClass()];`,
+        `const object = { value: new MyClass() };`,
+        `myFunction(new MyClass());`,
+        `new MyClass().method();`,
+        `const value = new MyClass() || fallback;`,
+        `const value = new MyClass() && other;`,
+        `const value = new MyClass() ?? fallback;`,
+    ],
+});

package/lib/rules/newNativeNonConstructors.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Disallows using `new` with global non-constructor functions like Symbol and BigInt.";
+    readonly id: "newNativeNonConstructors";
+    readonly preset: "untyped";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "noNewNonConstructor", undefined>;
+export default _default;

package/lib/rules/newNativeNonConstructors.js

@@ -0,0 +1,49 @@
+import * as ts from "typescript";
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+import { isGlobalDeclaration } from "../utils/isGlobalDeclaration.js";
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Disallows using `new` with global non-constructor functions like Symbol and BigInt.",
+        id: "newNativeNonConstructors",
+        preset: "untyped",
+    },
+    messages: {
+        noNewNonConstructor: {
+            primary: "{{ name }} cannot be called with `new`.",
+            secondary: [
+                "`Symbol` and `BigInt` are not constructors and will throw a `TypeError` when called with `new`.",
+                "These functions should be called directly without the `new` keyword to create their respective values.",
+            ],
+            suggestions: ["Remove the `new` keyword and call the function directly."],
+        },
+    },
+    setup(context) {
+        return {
+            visitors: {
+                NewExpression: (node) => {
+                    if (!ts.isIdentifier(node.expression)) {
+                        return;
+                    }
+                    const name = node.expression.text;
+                    if (!["BigInt", "Symbol"].includes(name) ||
+                        !isGlobalDeclaration(node.expression, context.typeChecker)) {
+                        return;
+                    }
+                    context.report({
+                        data: { name },
+                        fix: {
+                            range: {
+                                begin: node.getStart(context.sourceFile),
+                                end: node.expression.getStart(context.sourceFile),
+                            },
+                            text: "",
+                        },
+                        message: "noNewNonConstructor",
+                        range: getTSNodeRange(node.getChildAt(0, context.sourceFile), context.sourceFile),
+                    });
+                },
+            },
+        };
+    },
+});

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

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