@flint.fyi/ts 0.14.1 → 0.14.3

package/lib/rules/exceptionAssignments.test.js

@@ -0,0 +1,264 @@
+import rule from "./exceptionAssignments.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    error = new Error("Different error");
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    error = new Error("Different error");
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (exception) {
+    exception = null;
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (exception) {
+    exception = null;
+    ~~~~~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    error++;
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    error++;
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    ++error;
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    ++error;
+      ~~~~~
+      Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    error += "additional info";
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    error += "additional info";
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    error ??= new Error("default error");
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    error ??= new Error("default error");
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    error &&= false;
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    error &&= false;
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    error ||= new Error("fallback");
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    error ||= new Error("fallback");
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch (error) {
+    function inner() {
+        error = "reassigned in nested function";
+    }
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch (error) {
+    function inner() {
+        error = "reassigned in nested function";
+        ~~~~~
+        Exception parameters in catch clauses should not be reassigned.
+    }
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch ({ message }) {
+    message = "reassigned destructured parameter";
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch ({ message }) {
+    message = "reassigned destructured parameter";
+    ~~~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch ({ message, code }) {
+    code = 500;
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch ({ message, code }) {
+    code = 500;
+    ~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+try {
+    doSomething();
+} catch ([first, second]) {
+    first = "reassigned array destructured parameter";
+}
+`,
+            snapshot: `
+try {
+    doSomething();
+} catch ([first, second]) {
+    first = "reassigned array destructured parameter";
+    ~~~~~
+    Exception parameters in catch clauses should not be reassigned.
+}
+`,
+        },
+    ],
+    valid: [
+        `try { doSomething(); } catch (error) { console.log(error); }`,
+        `try { doSomething(); } catch (error) { throw error; }`,
+        `try { doSomething(); } catch (error) { const message = error.message; }`,
+        `try { doSomething(); } catch (error) { if (error instanceof TypeError) { handle(); } }`,
+        `try { doSomething(); } catch { handleError(); }`,
+        `const error = new Error("test");`,
+        `
+try {
+    doSomething();
+} catch (error) {
+    const error = "shadowed variable";
+    console.log(error);
+}
+`,
+        `
+try {
+    doSomething();
+} catch (error) {
+    function inner() {
+        const error = "shadowed in function";
+        error = "reassigning shadowed variable is ok";
+    }
+}
+`,
+        `
+let error = "outer";
+try {
+    doSomething();
+} catch (error) {
+    console.log(error);
+}
+error = "reassigning outer is ok";
+`,
+        `try { doSomething(); } catch ({ message }) { console.log(message); }`,
+        `try { doSomething(); } catch ({ message, code }) { if (code === 404) { handle(); } }`,
+        `try { doSomething(); } catch ([first]) { console.log(first); }`,
+    ],
+});

package/lib/rules/functionAssignments.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports reassigning variables declared with function declarations.";
+    readonly id: "functionAssignments";
+    readonly preset: "untyped";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "noFunctionAssignment", undefined>;
+export default _default;

package/lib/rules/functionAssignments.js

@@ -0,0 +1,42 @@
+import { typescriptLanguage } from "../language.js";
+import { getModifyingReferences } from "../utils/getModifyingReferences.js";
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports reassigning variables declared with function declarations.",
+        id: "functionAssignments",
+        preset: "untyped",
+    },
+    messages: {
+        noFunctionAssignment: {
+            primary: "Variables declared with function declarations should not be reassigned.",
+            secondary: [
+                "Reassigning a function declaration can make code harder to understand and maintain.",
+                "Function declarations are hoisted to the top of their scope, and reassigning them can lead to unexpected behavior.",
+            ],
+            suggestions: [
+                "Use a function expression or const variable instead if you need to reassign the function.",
+            ],
+        },
+    },
+    setup(context) {
+        return {
+            visitors: {
+                FunctionDeclaration: (node) => {
+                    if (!node.name) {
+                        return;
+                    }
+                    const modifyingReferences = getModifyingReferences(node.name, context.sourceFile, context.typeChecker);
+                    for (const reference of modifyingReferences) {
+                        context.report({
+                            message: "noFunctionAssignment",
+                            range: {
+                                begin: reference.getStart(context.sourceFile),
+                                end: reference.getEnd(),
+                            },
+                        });
+                    }
+                },
+            },
+        };
+    },
+});

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

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

package/lib/rules/functionAssignments.test.js

@@ -0,0 +1,209 @@
+import rule from "./functionAssignments.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+function myFunction() {}
+myFunction = function() {};
+`,
+            snapshot: `
+function myFunction() {}
+myFunction = function() {};
+~~~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function myFunction() {}
+myFunction = 123;
+`,
+            snapshot: `
+function myFunction() {}
+myFunction = 123;
+~~~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function myFunction() {}
+myFunction += 1;
+`,
+            snapshot: `
+function myFunction() {}
+myFunction += 1;
+~~~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function myFunction() {}
+myFunction++;
+`,
+            snapshot: `
+function myFunction() {}
+myFunction++;
+~~~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function myFunction() {}
+++myFunction;
+`,
+            snapshot: `
+function myFunction() {}
+++myFunction;
+  ~~~~~~~~~~
+  Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function myFunction() {
+    return 42;
+}
+myFunction = () => 100;
+`,
+            snapshot: `
+function myFunction() {
+    return 42;
+}
+myFunction = () => 100;
+~~~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function outer() {
+    function inner() {}
+    inner = function() {};
+}
+`,
+            snapshot: `
+function outer() {
+    function inner() {}
+    inner = function() {};
+    ~~~~~
+    Variables declared with function declarations should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+function myFunction() {}
+if (condition) {
+    myFunction = null;
+}
+`,
+            snapshot: `
+function myFunction() {}
+if (condition) {
+    myFunction = null;
+    ~~~~~~~~~~
+    Variables declared with function declarations should not be reassigned.
+}
+`,
+        },
+        {
+            code: `
+function getValue() {
+    return 1;
+}
+getValue ??= function() { return 0; };
+`,
+            snapshot: `
+function getValue() {
+    return 1;
+}
+getValue ??= function() { return 0; };
+~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function getValue() {
+    return true;
+}
+getValue &&= false;
+`,
+            snapshot: `
+function getValue() {
+    return true;
+}
+getValue &&= false;
+~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function getValue() {
+    return false;
+}
+getValue ||= () => true;
+`,
+            snapshot: `
+function getValue() {
+    return false;
+}
+getValue ||= () => true;
+~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+        {
+            code: `
+function calculate(value: number): number {
+    return value * 2;
+}
+calculate = (value: number) => value * 3;
+`,
+            snapshot: `
+function calculate(value: number): number {
+    return value * 2;
+}
+calculate = (value: number) => value * 3;
+~~~~~~~~~
+Variables declared with function declarations should not be reassigned.
+`,
+        },
+    ],
+    valid: [
+        `function myFunction() { return 42; }`,
+        `function myFunction() {} const result = myFunction();`,
+        `const myFunction = function() {}; myFunction = () => {};`,
+        `const myFunction = () => {}; myFunction = function() {};`,
+        `let myFunction = function() {}; myFunction = () => {};`,
+        `function outer() { const inner = function() {}; inner = () => {}; }`,
+        `
+function outer() {
+    const myFunction = "shadowed variable";
+    myFunction = "reassigning shadowed variable is ok";
+}
+`,
+        `
+let myFunction = "outer variable";
+function scope() {
+    function myFunction() {}
+    console.log(myFunction);
+}
+myFunction = "reassigning outer is ok";
+`,
+        `function myFunction() {} const copy = myFunction;`,
+        `function myFunction() {} if (condition) { callWith(myFunction); }`,
+        `
+function myFunction() {
+    return function nested() {
+        return 42;
+    };
+}
+`,
+    ],
+});

package/lib/rules/generatorFunctionYields.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports generator functions that do not yield values.";
+    readonly id: "generatorFunctionYields";
+    readonly preset: "logical";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "missingYield", undefined>;
+export default _default;

package/lib/rules/generatorFunctionYields.js

@@ -0,0 +1,57 @@
+import * as tsutils from "ts-api-utils";
+import * as ts from "typescript";
+import { typescriptLanguage } from "../language.js";
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports generator functions that do not yield values.",
+        id: "generatorFunctionYields",
+        preset: "logical",
+    },
+    messages: {
+        missingYield: {
+            primary: "Generator functions must contain at least one yield expression to produce values.",
+            secondary: [
+                "Generator functions use the `function*` syntax to create iterators that can produce multiple values over time.",
+                "Without a yield expression, the generator will not produce any values and behaves like an empty iterator.",
+                "This is likely unintentional and indicates incomplete implementation or a misunderstanding of generator functions.",
+            ],
+            suggestions: [
+                "Add a `yield` expression to produce values from the generator.",
+                "If the function should not be a generator, remove the asterisk (`*`) from the function declaration.",
+            ],
+        },
+    },
+    setup(context) {
+        return {
+            visitors: {
+                FunctionDeclaration: checkFunction,
+                FunctionExpression: checkFunction,
+                MethodDeclaration: checkFunction,
+            },
+        };
+        function checkFunction(node) {
+            if (!node.asteriskToken || !node.body || blockContainsYield(node.body)) {
+                return;
+            }
+            context.report({
+                message: "missingYield",
+                range: {
+                    begin: node.asteriskToken.getStart(context.sourceFile),
+                    end: node.asteriskToken.getEnd(),
+                },
+            });
+        }
+    },
+});
+function blockContainsYield(block) {
+    function checkForYield(node) {
+        if (ts.isYieldExpression(node)) {
+            return true;
+        }
+        if (tsutils.isFunctionScopeBoundary(node)) {
+            return false;
+        }
+        return ts.forEachChild(node, checkForYield);
+    }
+    return ts.forEachChild(block, checkForYield);
+}

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

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