@dvukovic/style-guide 0.10.3 → 0.12.0

package/dist/scripts/changelog-report.types.d.ts

@@ -0,0 +1,28 @@
+export type OutdatedPackageType = {
+    current: string;
+    latest: string;
+    name: string;
+};
+export type NpmRegistryResponseType = {
+    repository?: {
+        url?: string;
+    };
+};
+export type GitHubReleaseType = {
+    body: string;
+    name: string;
+    published_at: string;
+    tag_name: string;
+};
+export type PackageChangelogType = {
+    changelog: string;
+    current: string;
+    latest: string;
+    name: string;
+};
+export type NpmOutdatedEntryType = {
+    current: string;
+    latest: string;
+    wanted: string;
+};
+export type NpmOutdatedOutputType = Record<string, NpmOutdatedEntryType>;

package/dist/src/eslint/configs/typescript.d.ts

@@ -0,0 +1,13 @@
+/**
+ * TypeScript ESLint configuration with parser setup and rules
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends & { onlyFiles?: string[] }} [config]
+ *   - Additional config
+ *
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function typescript(config?: import("@eslint/config-helpers").ConfigWithExtends & {
+    onlyFiles?: string[];
+}): import("@eslint/config-helpers").ConfigWithExtends;
+/** @type {import("eslint").Linter.Config[]} */
+export const typescriptConfig: import("eslint").Linter.Config[];

package/dist/src/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/src/prettier/configs/core.test.d.ts

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

package/dist/src/stylelint/configs/core.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dvukovic/style-guide",
-    "version": "0.10.3",
+    "version": "0.12.0",
     "description": "My own style guide",
     "repository": {
         "type": "git",
@@ -58,21 +58,21 @@
         "test": "vitest run"
     },
     "dependencies": {
-        "@clack/prompts": "0.10.0",
-        "@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-        "@eslint/config-helpers": "0.4.2",
-        "@next/eslint-plugin-next": "16.1.0",
+        "@clack/prompts": "0.11.0",
+        "@eslint-community/eslint-plugin-eslint-comments": "4.6.0",
+        "@eslint/config-helpers": "0.5.1",
+        "@next/eslint-plugin-next": "16.1.4",
         "@rimac-technology/eslint-plugin": "1.5.0",
-        "@stylistic/eslint-plugin": "5.6.1",
-        "@typescript-eslint/parser": "8.50.0",
-        "@vitest/eslint-plugin": "1.5.4",
+        "@stylistic/eslint-plugin": "5.7.1",
+        "@typescript-eslint/parser": "8.53.1",
+        "@vitest/eslint-plugin": "1.6.6",
         "eslint-plugin-baseline-js": "0.4.2",
         "eslint-plugin-import-x": "4.16.1",
-        "eslint-plugin-jest": "29.4.0",
+        "eslint-plugin-jest": "29.12.1",
         "eslint-plugin-mobx": "0.0.13",
-        "eslint-plugin-n": "17.23.1",
-        "eslint-plugin-package-json": "0.88.1",
-        "eslint-plugin-playwright": "2.4.0",
+        "eslint-plugin-n": "17.23.2",
+        "eslint-plugin-package-json": "0.88.2",
+        "eslint-plugin-playwright": "2.5.0",
         "eslint-plugin-promise": "7.2.1",
         "eslint-plugin-react": "7.37.5",
         "eslint-plugin-react-hooks": "7.0.1",
@@ -81,35 +81,37 @@
         "eslint-plugin-sonarjs": "3.0.5",
         "eslint-plugin-sort-destructure-keys": "2.0.0",
         "eslint-plugin-sort-keys-fix": "1.1.2",
-        "eslint-plugin-storybook": "10.1.10",
+        "eslint-plugin-storybook": "10.2.0",
         "eslint-plugin-typescript-sort-keys": "3.3.0",
         "eslint-plugin-unicorn": "62.0.0",
         "eslint-plugin-unused-imports": "4.3.0",
-        "globals": "16.5.0",
+        "globals": "17.1.0",
         "jsonc-eslint-parser": "2.4.2",
         "prettier-plugin-embed": "0.5.1",
         "prettier-plugin-jsdoc": "1.8.0",
-        "prettier-plugin-packagejson": "2.5.20",
+        "prettier-plugin-packagejson": "3.0.0",
         "prettier-plugin-prisma": "5.0.0",
         "prettier-plugin-sh": "0.18.0",
         "prettier-plugin-sql": "0.19.2",
         "prettier-plugin-tailwindcss": "0.7.2",
         "prettier-plugin-toml": "2.0.6",
         "stylelint-no-unused-selectors": "1.0.40",
-        "stylelint-order": "7.0.0",
-        "typescript-eslint": "8.50.0"
+        "stylelint-order": "7.0.1",
+        "typescript-eslint": "8.53.1"
     },
     "devDependencies": {
         "@release-it/conventional-changelog": "10.0.4",
-        "@types/node": "24.10.4",
-        "cspell": "9.4.0",
+        "@types/node": "24.10.9",
+        "@types/semver": "7.7.1",
+        "cspell": "9.6.0",
         "eslint": "9.39.2",
         "knip": "5.82.1",
-        "prettier": "3.7.4",
-        "release-it": "19.1.0",
+        "prettier": "3.8.1",
+        "release-it": "19.2.4",
+        "semver": "7.7.3",
         "stylelint": "16.26.1",
         "typescript": "5.9.3",
-        "vitest": "4.0.16"
+        "vitest": "4.0.18"
     },
     "peerDependencies": {
         "cspell": "9",

package/src/cspell/base.txt

@@ -141,3 +141,4 @@ nuqs
 volta
 timeslot
 blackhill
+rcompare

package/src/eslint/configs/typescript.js

@@ -3,6 +3,7 @@ import tseslint from "typescript-eslint"
 import { typescriptEslint } from "../plugins/typescript-eslint.js"
 import { typescriptSortKeys } from "../plugins/typescript-sort-keys.js"
 
+/** @type {import("eslint").Linter.Config[]} */
 export const typescriptConfig = [
     {
         files: ["**/*.js", "**/*.ts", "**/*.tsx", "**/*.cjs"],

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/jest.js

@@ -37,6 +37,7 @@ export const jest = {
         "jest/no-disabled-tests": "error",
         "jest/no-done-callback": "error",
         "jest/no-duplicate-hooks": "error",
+        "jest/no-error-equal": "error",
         "jest/no-export": "error",
         "jest/no-focused-tests": "error",
         "jest/no-identical-title": "error",
@@ -46,6 +47,8 @@ export const jest = {
         "jest/no-standalone-expect": "error",
         "jest/no-test-prefixes": "error",
         "jest/no-test-return-statement": "error",
+        "jest/no-unnecessary-assertion": "error",
+        "jest/no-unneeded-async-expect-function": "error",
         "jest/no-untyped-mock-factory": "error",
         "jest/padding-around-after-all-blocks": "error",
         "jest/padding-around-after-each-blocks": "error",
@@ -64,6 +67,7 @@ export const jest = {
         "jest/prefer-jest-mocked": "error",
         "jest/prefer-lowercase-title": ["error", { ignoreTopLevelDescribe: true }],
         "jest/prefer-mock-promise-shorthand": "error",
+        "jest/prefer-mock-return-shorthand": "error",
         "jest/prefer-spy-on": "error",
         "jest/prefer-strict-equal": "error",
         "jest/prefer-to-be": "error",
@@ -78,6 +82,7 @@ export const jest = {
         "jest/valid-describe-callback": "error",
         "jest/valid-expect": "error",
         "jest/valid-expect-in-promise": "error",
+        "jest/valid-expect-with-promise": "error",
         "jest/valid-mock-module-path": "error",
         "jest/valid-title": "error",
     },

package/src/eslint/plugins/playwright.js

@@ -6,6 +6,7 @@ export const playwright = {
         playwright: plugin,
     },
     rules: {
+        "playwright/enforce-consistent-spacing-between-blocks": "error",
         "playwright/expect-expect": "error",
         "playwright/max-expects": ["error", { max: 15 }],
         "playwright/max-nested-describe": ["error", { max: 4 }],

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/plugins/vitest.js

@@ -93,6 +93,7 @@ export const vitest = {
         "@vitest/valid-expect": "error",
         "@vitest/valid-expect-in-promise": "error",
         "@vitest/valid-title": "error",
+        "@vitest/vitest/prefer-mock-return-shorthand": "error",
         "@vitest/warn-todo": "warn",
     },
 }

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)
+    })
+})

package/dist/eslint/configs/typescript.d.ts

@@ -1,24 +0,0 @@
-/**
- * TypeScript ESLint configuration with parser setup and rules
- *
- * @param {import("@eslint/config-helpers").ConfigWithExtends & { onlyFiles?: string[] }} [config]
- *   - Additional config
- *
- * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
- */
-export function typescript(config?: import("@eslint/config-helpers").ConfigWithExtends & {
-    onlyFiles?: string[];
-}): import("@eslint/config-helpers").ConfigWithExtends;
-export const typescriptConfig: {
-    name?: string;
-    basePath?: string;
-    files: (string | string[])[];
-    ignores?: string[];
-    language?: string;
-    languageOptions?: import("@eslint/core").LanguageOptions;
-    linterOptions?: import("@eslint/core").LinterOptionsConfig;
-    processor?: string | import("@eslint/core").Processor;
-    plugins?: Record<string, import("@eslint/core").Plugin>;
-    rules?: Partial<import("@eslint/core").RulesConfig> | undefined;
-    settings?: Record<string, unknown>;
-}[];