@flint.fyi/ts 0.14.3 → 0.14.4

package/lib/rules/caseDuplicates.test.js

@@ -0,0 +1,307 @@
+import rule from "./caseDuplicates.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+switch (value) {
+    case 1:
+        break;
+    case 1:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case 1:
+        break;
+    case 1:
+    ~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case "a":
+        break;
+    case "b":
+        break;
+    case "a":
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case "a":
+        break;
+    case "b":
+        break;
+    case "a":
+    ~~~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case x + 1:
+        break;
+    case x + 1:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case x + 1:
+        break;
+    case x + 1:
+    ~~~~~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case 1:
+        break;
+    case 2:
+        break;
+    case 1:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case 1:
+        break;
+    case 2:
+        break;
+    case 1:
+    ~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case true:
+        break;
+    case false:
+        break;
+    case true:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case true:
+        break;
+    case false:
+        break;
+    case true:
+    ~~~~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case obj.property:
+        break;
+    case obj.property:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case obj.property:
+        break;
+    case obj.property:
+    ~~~~~~~~~~~~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+const result = (input: number) => {
+    switch (input) {
+        case 1:
+            return "one";
+        case 2:
+            return "two";
+        case 1:
+            return "duplicate";
+    }
+};
+`,
+            snapshot: `
+const result = (input: number) => {
+    switch (input) {
+        case 1:
+            return "one";
+        case 2:
+            return "two";
+        case 1:
+        ~~~~~~
+        This case duplicates a previous case, so it will never be reached.
+            return "duplicate";
+    }
+};
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case 1: case 1: break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case 1: case 1: break;
+            ~~~~~~
+            This case duplicates a previous case, so it will never be reached.
+}
+`,
+        },
+        {
+            code: `
+const condition = true;
+switch (value) {
+    case condition ? "a" : "b":
+        break;
+    case condition ? "a" : "b":
+        break;
+}
+`,
+            snapshot: `
+const condition = true;
+switch (value) {
+    case condition ? "a" : "b":
+        break;
+    case condition ? "a" : "b":
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case /* comment */ 1:
+        break;
+    case 1:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case /* comment */ 1:
+        break;
+    case 1:
+    ~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+        {
+            code: `
+switch (value) {
+    case obj.property:
+        break;
+    case obj /* comment */ .property:
+        break;
+}
+`,
+            snapshot: `
+switch (value) {
+    case obj.property:
+        break;
+    case obj /* comment */ .property:
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    This case duplicates a previous case, so it will never be reached.
+        break;
+}
+`,
+        },
+    ],
+    valid: [
+        `switch (value) { case 1: break; case 2: break; }`,
+        `switch (value) { case 1: break; case 2: break; case 3: break; }`,
+        `switch (value) { case "a": break; case "b": break; }`,
+        `switch (value) { case true: break; case false: break; }`,
+        `switch (value) { case 1: case 2: break; }`,
+        `switch (value) { default: break; }`,
+        `
+switch (value) {
+    case 1:
+        break;
+    case 2:
+        break;
+}
+`,
+        `
+switch (value) {
+    case x:
+        break;
+    case y:
+        break;
+}
+`,
+        `
+switch (value) {
+    case obj.a:
+        break;
+    case obj.b:
+        break;
+}
+`,
+        `
+switch (value) {
+    case 1:
+        console.log("one");
+        break;
+    case 2:
+        console.log("two");
+        break;
+    default:
+        console.log("default");
+        break;
+}
+`,
+        `
+switch (value) {
+    case x + 1:
+        break;
+    case x + 2:
+        break;
+}
+`,
+        `
+const result = (input: number) => {
+    switch (input) {
+        case 1:
+            return "one";
+        case 2:
+            return "two";
+        default:
+            return "unknown";
+    }
+};
+`,
+    ],
+});

package/lib/rules/elseIfDuplicates.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports duplicate conditions in if-else-if chains that make code unreachable.";
+    readonly id: "elseIfDuplicates";
+    readonly preset: "logical";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "duplicateCondition", undefined>;
+export default _default;

package/lib/rules/elseIfDuplicates.js

@@ -0,0 +1,53 @@
+import * as ts from "typescript";
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+import { hasSameTokens } from "../utils/hasSameTokens.js";
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports duplicate conditions in if-else-if chains that make code unreachable.",
+        id: "elseIfDuplicates",
+        preset: "logical",
+    },
+    messages: {
+        duplicateCondition: {
+            primary: "This condition is identical to a previous condition in the if-else-if chain.",
+            secondary: [
+                "When an if-else-if chain has duplicate conditions, the duplicate branch will never execute because the earlier identical condition will always be evaluated first.",
+                "This typically indicates a copy-paste error or logic mistake.",
+            ],
+            suggestions: [
+                "Verify the condition logic is correct and update to check for the intended condition.",
+            ],
+        },
+    },
+    setup(context) {
+        function checkIfStatement(node) {
+            const seen = [];
+            let current = node;
+            while (true) {
+                if (seen.some((previous) => hasSameTokens(previous, current.expression, context.sourceFile))) {
+                    context.report({
+                        message: "duplicateCondition",
+                        range: getTSNodeRange(current.expression, context.sourceFile),
+                    });
+                }
+                if (!current.elseStatement ||
+                    !ts.isIfStatement(current.elseStatement)) {
+                    break;
+                }
+                seen.push(current.expression);
+                current = current.elseStatement;
+            }
+        }
+        return {
+            visitors: {
+                IfStatement: (node) => {
+                    if (!ts.isIfStatement(node.parent) ||
+                        node.parent.elseStatement !== node) {
+                        checkIfStatement(node);
+                    }
+                },
+            },
+        };
+    },
+});

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

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

package/lib/rules/elseIfDuplicates.test.js

@@ -0,0 +1,176 @@
+import rule from "./elseIfDuplicates.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+if (isSomething(value)) {
+    doFirst();
+} else if (isSomething(value)) {
+    doSecond();
+}
+`,
+            snapshot: `
+if (isSomething(value)) {
+    doFirst();
+} else if (isSomething(value)) {
+           ~~~~~~~~~~~~~~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    doSecond();
+}
+`,
+        },
+        {
+            code: `
+if (isSomething /* ... */ (value)) {
+    doFirst();
+} else if (isSomething(value /* ... */)) {
+    doSecond();
+}
+`,
+            snapshot: `
+if (isSomething /* ... */ (value)) {
+    doFirst();
+} else if (isSomething(value /* ... */)) {
+           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    doSecond();
+}
+`,
+        },
+        {
+            code: `
+if (first) {
+    handleFirst();
+} else if (second) {
+    handleSecond();
+} else if (third && fourth) {
+    handleThird();
+} else if (third && fourth) {
+    handleFourth();
+}
+`,
+            snapshot: `
+if (first) {
+    handleFirst();
+} else if (second) {
+    handleSecond();
+} else if (third && fourth) {
+    handleThird();
+} else if (third && fourth) {
+           ~~~~~~~~~~~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    handleFourth();
+}
+`,
+        },
+        {
+            code: `
+if (count === 1) {
+    handleOne();
+} else if (count === 2) {
+    handleTwo();
+} else if (count === 3) {
+    handleThree();
+} else if (count === 2) {
+    handleFour();
+} else if (count === 5) {
+    handleFive();
+}
+`,
+            snapshot: `
+if (count === 1) {
+    handleOne();
+} else if (count === 2) {
+    handleTwo();
+} else if (count === 3) {
+    handleThree();
+} else if (count === 2) {
+           ~~~~~~~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    handleFour();
+} else if (count === 5) {
+    handleFive();
+}
+`,
+        },
+        {
+            code: `
+if (value === "first") {
+    process();
+} else if (value === "second") {
+    process();
+} else if (value === "first") {
+    process();
+}
+`,
+            snapshot: `
+if (value === "first") {
+    process();
+} else if (value === "second") {
+    process();
+} else if (value === "first") {
+           ~~~~~~~~~~~~~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    process();
+}
+`,
+        },
+        {
+            code: `
+if (isValid && isActive) {
+    execute();
+} else if (isPending) {
+    wait();
+} else if (isValid && isActive) {
+    execute();
+}
+`,
+            snapshot: `
+if (isValid && isActive) {
+    execute();
+} else if (isPending) {
+    wait();
+} else if (isValid && isActive) {
+           ~~~~~~~~~~~~~~~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    execute();
+}
+`,
+        },
+        {
+            code: `
+if (value) {
+    first();
+} else if (value) {
+    second();
+} else if (value) {
+    third();
+}
+`,
+            snapshot: `
+if (value) {
+    first();
+} else if (value) {
+           ~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    second();
+} else if (value) {
+           ~~~~~
+           This condition is identical to a previous condition in the if-else-if chain.
+    third();
+}
+`,
+        },
+    ],
+    valid: [
+        `if (isSomething(value)) { doFirst(); } else if (isSomethingElse(value)) { doSecond(); }`,
+        `if (first) { handleFirst(); } else if (second) { handleSecond(); } else if (third && fourth) { handleThird(); } else if (third && fifth) { handleFourth(); }`,
+        `if (count === 1) { handleOne(); } else if (count === 2) { handleTwo(); } else if (count === 3) { handleThree(); } else if (count === 4) { handleFour(); }`,
+        `if (value === "first") { process(); } else if (value === "second") { process(); } else if (value === "third") { process(); }`,
+        `if (isValid) { execute(); } else if (isPending) { wait(); } else if (isInvalid) { reject(); }`,
+        `if (value) { process(); }`,
+        `if (first) { doFirst(); } else { doSecond(); }`,
+        `if (first) { doFirst(); } else if (second) { doSecond(); } else { doDefault(); }`,
+    ],
+});

package/lib/rules/forDirections.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports for loops with counter variables that move in the wrong direction.";
+    readonly id: "forDirections";
+    readonly preset: "stylistic";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "wrongDirection", undefined>;
+export default _default;

package/lib/rules/forDirections.js

@@ -0,0 +1,124 @@
+import * as ts from "typescript";
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+function getConditionDirection(condition, counterName) {
+    if (!ts.isBinaryExpression(condition)) {
+        return undefined;
+    }
+    const leftName = getCounterName(condition.left);
+    const rightName = getCounterName(condition.right);
+    const isCounterLeft = leftName === counterName;
+    const isCounterRight = rightName === counterName;
+    if (!isCounterLeft && !isCounterRight) {
+        return undefined;
+    }
+    const { operatorToken } = condition;
+    if (isCounterLeft) {
+        if (operatorToken.kind === ts.SyntaxKind.LessThanToken ||
+            operatorToken.kind === ts.SyntaxKind.LessThanEqualsToken) {
+            return 1;
+        }
+        if (operatorToken.kind === ts.SyntaxKind.GreaterThanToken ||
+            operatorToken.kind === ts.SyntaxKind.GreaterThanEqualsToken) {
+            return -1;
+        }
+    }
+    else {
+        if (operatorToken.kind === ts.SyntaxKind.LessThanToken ||
+            operatorToken.kind === ts.SyntaxKind.LessThanEqualsToken) {
+            return -1;
+        }
+        if (operatorToken.kind === ts.SyntaxKind.GreaterThanToken ||
+            operatorToken.kind === ts.SyntaxKind.GreaterThanEqualsToken) {
+            return 1;
+        }
+    }
+    return undefined;
+}
+function getCounterName(node) {
+    return ts.isIdentifier(node) ? node.text : undefined;
+}
+function getUpdateDirection(update) {
+    if (ts.isPostfixUnaryExpression(update) ||
+        ts.isPrefixUnaryExpression(update)) {
+        switch (update.operator) {
+            case ts.SyntaxKind.MinusMinusToken:
+                return -1;
+            case ts.SyntaxKind.PlusPlusToken:
+                return 1;
+            default:
+                return undefined;
+        }
+    }
+    if (ts.isBinaryExpression(update)) {
+        const { operatorToken, right } = update;
+        if (operatorToken.kind === ts.SyntaxKind.PlusEqualsToken ||
+            operatorToken.kind === ts.SyntaxKind.MinusEqualsToken) {
+            if (ts.isNumericLiteral(right)) {
+                const value = Number(right.text);
+                if (operatorToken.kind === ts.SyntaxKind.PlusEqualsToken) {
+                    return value > 0 ? 1 : value < 0 ? -1 : 0;
+                }
+                return value > 0 ? -1 : value < 0 ? 1 : 0;
+            }
+            if (ts.isPrefixUnaryExpression(right) &&
+                right.operator === ts.SyntaxKind.MinusToken &&
+                ts.isNumericLiteral(right.operand)) {
+                const value = Number(right.operand.text);
+                if (operatorToken.kind === ts.SyntaxKind.PlusEqualsToken) {
+                    return value > 0 ? -1 : 1;
+                }
+                return value > 0 ? 1 : -1;
+            }
+        }
+    }
+    return undefined;
+}
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports for loops with counter variables that move in the wrong direction.",
+        id: "forDirections",
+        preset: "stylistic",
+    },
+    messages: {
+        wrongDirection: {
+            primary: "The update moves the counter in the wrong direction for this loop condition.",
+            secondary: [
+                "A for loop with a counter that moves in the wrong direction relative to its stop condition will run infinitely or never execute.",
+                "When the counter increases but the condition expects it to decrease (or vice versa), the loop logic is incorrect.",
+            ],
+            suggestions: [
+                "Verify the loop counter update direction matches the condition.",
+            ],
+        },
+    },
+    setup(context) {
+        return {
+            visitors: {
+                ForStatement: (node) => {
+                    if (!node.condition ||
+                        !node.incrementor ||
+                        !node.initializer ||
+                        !ts.isVariableDeclarationList(node.initializer)) {
+                        return;
+                    }
+                    const declaration = node.initializer.declarations.at(0);
+                    if (!declaration || !ts.isIdentifier(declaration.name)) {
+                        return;
+                    }
+                    const updateDirection = getUpdateDirection(node.incrementor);
+                    if (!updateDirection) {
+                        return;
+                    }
+                    const conditionDirection = getConditionDirection(node.condition, declaration.name.text);
+                    if (updateDirection !== conditionDirection) {
+                        context.report({
+                            message: "wrongDirection",
+                            range: getTSNodeRange(node.incrementor, context.sourceFile),
+                        });
+                    }
+                },
+            },
+        };
+    },
+});

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

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