@flint.fyi/ts 0.14.2 → 0.14.3

package/lib/rules/emptyStaticBlocks.test.js

@@ -0,0 +1,167 @@
+import rule from "./emptyStaticBlocks.js";
+import { ruleTester } from "./ruleTester.js";
+ruleTester.describe(rule, {
+    invalid: [
+        {
+            code: `
+class Example {
+    static {
+    }
+}
+`,
+            snapshot: `
+class Example {
+    static {
+    ~~~~~~~~
+    Empty static blocks serve no purpose and should be removed for cleaner code.
+    }
+}
+`,
+            suggestions: [
+                {
+                    id: "removeEmptyStaticBlock",
+                    updated: `
+class Example {
+    
+}
+`,
+                },
+            ],
+        },
+        {
+            code: `
+class Example {
+    static {
+
+
+    }
+}
+`,
+            snapshot: `
+class Example {
+    static {
+    ~~~~~~~~
+    Empty static blocks serve no purpose and should be removed for cleaner code.
+
+
+    }
+}
+`,
+            suggestions: [
+                {
+                    id: "removeEmptyStaticBlock",
+                    updated: `
+class Example {
+    
+}
+`,
+                },
+            ],
+        },
+        {
+            code: `
+class Multiple {
+    static property = 1;
+    
+    static {
+    }
+    
+    method() {}
+}
+`,
+            snapshot: `
+class Multiple {
+    static property = 1;
+    
+    static {
+    ~~~~~~~~
+    Empty static blocks serve no purpose and should be removed for cleaner code.
+    }
+    
+    method() {}
+}
+`,
+            suggestions: [
+                {
+                    id: "removeEmptyStaticBlock",
+                    updated: `
+class Multiple {
+    static property = 1;
+    
+    
+    
+    method() {}
+}
+`,
+                },
+            ],
+        },
+        {
+            code: `
+class MultipleBlocks {
+    static {
+        console.log("first");
+    }
+    
+    static {
+    }
+}
+`,
+            snapshot: `
+class MultipleBlocks {
+    static {
+        console.log("first");
+    }
+    
+    static {
+    ~~~~~~~~
+    Empty static blocks serve no purpose and should be removed for cleaner code.
+    }
+}
+`,
+            suggestions: [
+                {
+                    id: "removeEmptyStaticBlock",
+                    updated: `
+class MultipleBlocks {
+    static {
+        console.log("first");
+    }
+    
+    
+}
+`,
+                },
+            ],
+        },
+    ],
+    valid: [
+        `class Example { static property = 1; }`,
+        `class Example { static method() {} }`,
+        `
+class Example {
+    static {
+        console.log("initialization");
+    }
+}
+`,
+        `
+class Example {
+    static {
+        this.property = 1;
+    }
+}
+`,
+        `
+class Multiple {
+    static {
+        console.log("first");
+    }
+    
+    static {
+        console.log("second");
+    }
+}
+`,
+    ],
+});

package/lib/rules/exceptionAssignments.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("@flint.fyi/core").Rule<{
+    readonly description: "Reports reassigning exception parameters in catch clauses.";
+    readonly id: "exceptionAssignments";
+    readonly preset: "logical";
+}, import("../nodes.js").TSNodesByName, import("../language.js").TypeScriptServices, "noExAssign", undefined>;
+export default _default;

package/lib/rules/exceptionAssignments.js

@@ -0,0 +1,61 @@
+import * as ts from "typescript";
+import { typescriptLanguage } from "../language.js";
+import { getModifyingReferences } from "../utils/getModifyingReferences.js";
+export default typescriptLanguage.createRule({
+    about: {
+        description: "Reports reassigning exception parameters in catch clauses.",
+        id: "exceptionAssignments",
+        preset: "logical",
+    },
+    messages: {
+        noExAssign: {
+            primary: "Exception parameters in catch clauses should not be reassigned.",
+            secondary: [
+                "Reassigning an exception parameter can make debugging more difficult by obscuring the original error.",
+                "The exception parameter contains important information about what went wrong, and reassigning it can make it harder to understand the root cause of an error.",
+            ],
+            suggestions: [
+                "Use a different variable name for the new value instead of reassigning the exception parameter.",
+            ],
+        },
+    },
+    setup(context) {
+        function collectBindingElements(name) {
+            const identifiers = [];
+            if (ts.isIdentifier(name)) {
+                identifiers.push(name);
+            }
+            else if (ts.isObjectBindingPattern(name) ||
+                ts.isArrayBindingPattern(name)) {
+                for (const element of name.elements) {
+                    if (ts.isBindingElement(element)) {
+                        identifiers.push(...collectBindingElements(element.name));
+                    }
+                }
+            }
+            return identifiers;
+        }
+        return {
+            visitors: {
+                CatchClause: (node) => {
+                    if (!node.variableDeclaration?.name) {
+                        return;
+                    }
+                    const identifiers = collectBindingElements(node.variableDeclaration.name);
+                    for (const identifier of identifiers) {
+                        const modifyingReferences = getModifyingReferences(identifier, context.sourceFile, context.typeChecker);
+                        for (const reference of modifyingReferences) {
+                            context.report({
+                                message: "noExAssign",
+                                range: {
+                                    begin: reference.getStart(context.sourceFile),
+                                    end: reference.getEnd(),
+                                },
+                            });
+                        }
+                    }
+                },
+            },
+        };
+    },
+});

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

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

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