@dvukovic/style-guide 0.10.3 → 0.11.0

package/dist/eslint/rules/document-todos/document-todos.d.ts

@@ -0,0 +1,24 @@
+export namespace documentTodos {
+    function create(context: any): {
+        Program(): void;
+    };
+    namespace meta {
+        namespace docs {
+            let description: string;
+        }
+        namespace messages {
+            let _default: string;
+            export { _default as default };
+        }
+        let schema: {
+            additionalProperties: boolean;
+            properties: {
+                url: {
+                    type: string;
+                };
+            };
+            type: string;
+        }[];
+        let type: string;
+    }
+}

package/dist/eslint/rules/document-todos/document-todos.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dvukovic/style-guide",
-    "version": "0.10.3",
+    "version": "0.11.0",
     "description": "My own style guide",
     "repository": {
         "type": "git",

package/src/eslint/plugins/dvukovic.js

@@ -1,3 +1,4 @@
+import { documentTodos } from "../rules/document-todos/document-todos.js"
 import { noCommentedOutCode } from "../rules/no-commented-out-code/no-commented-out-code.js"
 import { noT } from "../rules/no-t/no-t.js"
 
@@ -6,12 +7,14 @@ export const dvukovic = {
     plugins: {
         dvukovic: {
             rules: {
+                "document-todos": documentTodos,
                 "no-commented-out-code": noCommentedOutCode,
                 "no-t": noT,
             },
         },
     },
     rules: {
+        "dvukovic/document-todos": ["error", { url: "http" }],
         "dvukovic/no-commented-out-code": "error",
         "dvukovic/no-t": "error",
     },

package/src/eslint/plugins/rimac.js

@@ -7,6 +7,5 @@ export const rimac = {
     },
     rules: {
         "@rimac-technology/class-element-sorting": "error",
-        "@rimac-technology/document-todos": ["error", { url: "http" }],
     },
 }

package/src/eslint/rules/document-todos/document-todos.js

@@ -0,0 +1,63 @@
+export const documentTodos = {
+    create(context) {
+        const url = context.options[0]?.url
+
+        if (!url) {
+            throw new Error("URL not set for the document-todos rule. Please set the URL.")
+        }
+
+        return {
+            Program() {
+                const sourceCode = context.sourceCode
+                const comments = sourceCode.getAllComments()
+
+                for (const comment of comments) {
+                    const isTodo = comment.value.includes("TODO:")
+                    const isFixme = comment.value.includes("FIXME:")
+                    const hasLink = comment.value.includes(url.toLowerCase())
+                    const startsWithTodo = comment.value
+                        .trimStart()
+                        .toLowerCase()
+                        .startsWith("todo")
+                    const startsWithFixme = comment.value
+                        .trimStart()
+                        .toLowerCase()
+                        .startsWith("fixme")
+
+                    if ((isTodo || isFixme || startsWithFixme || startsWithTodo) && hasLink) {
+                        continue
+                    }
+
+                    if (!isTodo && !isFixme && !startsWithFixme && !startsWithTodo) {
+                        continue
+                    }
+
+                    context.report({
+                        loc: comment.loc,
+                        messageId: "default",
+                    })
+                }
+            },
+        }
+    },
+    meta: {
+        docs: {
+            description: "Ensure all TODOs and FIXMEs have an issue link attached to them",
+        },
+        messages: {
+            default: "All TODOs and FIXMEs must have an issue link attached to them",
+        },
+        schema: [
+            {
+                additionalProperties: false,
+                properties: {
+                    url: {
+                        type: "string",
+                    },
+                },
+                type: "object",
+            },
+        ],
+        type: "problem",
+    },
+}

package/src/eslint/rules/document-todos/document-todos.test.js

@@ -0,0 +1,174 @@
+import { ESLint } from "eslint"
+import tseslint from "typescript-eslint"
+
+import { documentTodos } from "./document-todos.js"
+
+const createEslint = (url = "http") => {
+    return new ESLint({
+        overrideConfig: [
+            {
+                files: ["**/*.ts"],
+                languageOptions: {
+                    parser: tseslint.parser,
+                },
+                plugins: {
+                    dvukovic: {
+                        rules: {
+                            "document-todos": documentTodos,
+                        },
+                    },
+                },
+                rules: {
+                    "dvukovic/document-todos": ["error", { url }],
+                },
+            },
+        ],
+        overrideConfigFile: true,
+    })
+}
+
+describe("dvukovic/document-todos", () => {
+    test("reports TODO without URL", async () => {
+        const eslint = createEslint()
+        const code = `// TODO: fix this later\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("reports FIXME without URL", async () => {
+        const eslint = createEslint()
+        const code = `// FIXME: broken feature\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("allows TODO with URL", async () => {
+        const eslint = createEslint()
+        const code = `// TODO: fix this later https://github.com/issue/1\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(0)
+    })
+
+    test("allows FIXME with URL", async () => {
+        const eslint = createEslint()
+        const code = `// FIXME: broken feature http://jira.com/123\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(0)
+    })
+
+    test("allows regular comments", async () => {
+        const eslint = createEslint()
+        const code = `// This is a regular comment\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(0)
+    })
+
+    test("reports lowercase todo without URL", async () => {
+        const eslint = createEslint()
+        const code = `// todo fix this later\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("reports lowercase fixme without URL", async () => {
+        const eslint = createEslint()
+        const code = `// fixme broken feature\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("reports TODO in block comments without URL", async () => {
+        const eslint = createEslint()
+        const code = `/* TODO: fix this later */\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("allows TODO in block comments with URL", async () => {
+        const eslint = createEslint()
+        const code = `/* TODO: fix this https://example.com/issue/1 */\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(0)
+    })
+
+    test("uses custom URL prefix", async () => {
+        const eslint = createEslint("https://jira.example.com")
+        const code = `// TODO: fix this https://jira.example.com/PROJ-123\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(0)
+    })
+
+    test("reports when URL does not match custom prefix", async () => {
+        const eslint = createEslint("https://jira.example.com")
+        const code = `// TODO: fix this https://github.com/issue/1\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("reports multiple TODO comments without URLs", async () => {
+        const eslint = createEslint()
+        const code = `// TODO: first issue\n// TODO: second issue\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/document-todos"
+        })
+
+        expect(errors?.length).toBe(2)
+    })
+})