eslint-config-axkit 1.4.0 → 1.6.0

package/README.md

@@ -1,6 +1,6 @@
 # eslint-config-axkit
 
-Reusable ESLint flat config for TypeScript + Node.js projects with strict type checking, Prettier, Unicorn, and Vitest.
+Reusable ESLint flat config for TypeScript + Node.js projects with strict type checking, Prettier, and Unicorn.
 
 ## Quick Start
 
@@ -83,12 +83,14 @@ export default [
 
 ## Options
 
-| Option          | Type      | Description                                                                                                                                                                                                                               |
-| --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `gitignorePath` | `string`  | Path to `.gitignore` file. Patterns will be added to ESLint's ignore list.                                                                                                                                                                |
-| `nextjs`        | `boolean` | Enable Next.js rules (`eslint-config-next` core-web-vitals + typescript). Requires `eslint-config-next` to be installed.                                                                                                                  |
-| `storybook`     | `boolean` | Enable Storybook rules (`eslint-plugin-storybook` flat/recommended). Requires `eslint-plugin-storybook` to be installed.                                                                                                                  |
-| `tailwindcss`   | `string`  | Path to the Tailwind CSS entry point (e.g. `"src/app/globals.css"`). Enables `eslint-plugin-better-tailwindcss` recommended rules enforcing stylistic and correctness rules. Requires `eslint-plugin-better-tailwindcss` to be installed. |
+| Option          | Type      | Description                                                                                                                                                                                                                                                      |
+| --------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `gitignorePath` | `string`  | Path to `.gitignore` file. Patterns will be added to ESLint's ignore list.                                                                                                                                                                                       |
+| `vitest`        | `boolean` | Enable Vitest ESLint rules for test files. Requires `@vitest/eslint-plugin` to be installed.                                                                                                                                                                     |
+| `fastify`       | `boolean` | Relax rules that conflict with idiomatic Fastify patterns. Configures `unicorn/prevent-abbreviations` with an allowList for common terms (`app`, `db`, `req`, etc.) and disables `@typescript-eslint/require-await` and `@typescript-eslint/strict-void-return`. |
+| `nextjs`        | `boolean` | Enable Next.js rules (`eslint-config-next` core-web-vitals + typescript). Requires `eslint-config-next` to be installed.                                                                                                                                         |
+| `storybook`     | `boolean` | Enable Storybook rules (`eslint-plugin-storybook` flat/recommended). Requires `eslint-plugin-storybook` to be installed.                                                                                                                                         |
+| `tailwindcss`   | `string`  | Path to the Tailwind CSS entry point (e.g. `"src/app/globals.css"`). Enables `eslint-plugin-better-tailwindcss` recommended rules enforcing stylistic and correctness rules. Requires `eslint-plugin-better-tailwindcss` to be installed.                        |
 
 ## Requirements
 

package/dist/index.d.ts

@@ -11,6 +11,18 @@ export type Options = {
      * Requires `eslint-config-next` to be installed.
      */
     nextjs?: boolean;
+    /**
+     * Enable Vitest ESLint rules for test files.
+     * Requires `@vitest/eslint-plugin` to be installed.
+     */
+    vitest?: boolean;
+    /**
+     * Relax rules that conflict with idiomatic Fastify patterns:
+     * - `unicorn/prevent-abbreviations` — configured with allowList for common Fastify terms (`app`, `db`, `req`, `res`, `opts`, `params`, etc.)
+     * - `@typescript-eslint/require-await` — disabled; `FastifyPluginAsync` requires `async` but plugin bodies often contain no `await`
+     * - `@typescript-eslint/strict-void-return` — disabled; route handlers use `return reply.notFound()` as control flow
+     */
+    fastify?: boolean;
     /**
      * Enable Storybook rules (eslint-plugin-storybook flat/recommended).
      * Requires `eslint-plugin-storybook` to be installed.
@@ -31,10 +43,11 @@ export type Options = {
  * - ESLint recommended rules
  * - TypeScript strict type checking
  * - Unicorn plugin (recommended)
- * - Vitest plugin for test files
+ * - `node:test` support (`allowForKnownSafeCalls` for promise-returning functions)
  * - Prettier compatibility (disables conflicting rules)
  *
  * Optional:
+ * - Vitest plugin for test files via `vitest: true`
  * - Next.js rules (core-web-vitals + typescript) via `nextjs: true`
  * - Storybook rules (flat/recommended) via `storybook: true`
  * - Tailwind CSS rules (better-tailwindcss/recommended) via `tailwindcss: "path/to/entry.css"`

package/dist/index.js

@@ -5,7 +5,8 @@ import eslintConfigPrettier from "eslint-config-prettier/flat";
 import eslintPluginUnicorn from "eslint-plugin-unicorn";
 import { importOptional } from "./import-optional.js";
 import { baseConfig } from "./base-config.js";
-import { vitestConfig } from "./vitest-config.js";
+import { nodeTestConfig } from "./node-test-config.js";
+import { createVitestConfig } from "./vitest-config.js";
 /**
  * Creates a complete ESLint flat config for TypeScript projects.
  *
@@ -13,17 +14,23 @@ import { vitestConfig } from "./vitest-config.js";
  * - ESLint recommended rules
  * - TypeScript strict type checking
  * - Unicorn plugin (recommended)
- * - Vitest plugin for test files
+ * - `node:test` support (`allowForKnownSafeCalls` for promise-returning functions)
  * - Prettier compatibility (disables conflicting rules)
  *
  * Optional:
+ * - Vitest plugin for test files via `vitest: true`
  * - Next.js rules (core-web-vitals + typescript) via `nextjs: true`
  * - Storybook rules (flat/recommended) via `storybook: true`
  * - Tailwind CSS rules (better-tailwindcss/recommended) via `tailwindcss: "path/to/entry.css"`
  */
 export async function axkit(options = {}) {
-    const { gitignorePath, nextjs, storybook, tailwindcss } = options;
-    const configs = [];
+    const { gitignorePath, vitest, fastify, nextjs, storybook, tailwindcss } = options;
+    const configs = [
+        {
+            name: "axkit/ignores",
+            ignores: [".agents/", ".claude/"],
+        },
+    ];
     // ── Gitignore ──────────────────────────────────────────────────────
     if (gitignorePath) {
         configs.push(includeIgnoreFile(gitignorePath, "Copy patterns from .gitignore"));
@@ -53,7 +60,41 @@ export async function axkit(options = {}) {
         name: "axkit/config-files",
         files: ["*.config.{js,ts,mjs,mts}"],
         ...tseslint.configs.disableTypeChecked,
-    }, vitestConfig);
+    }, 
+    // node:test (always applied — harmless if not using node:test)
+    nodeTestConfig);
+    // ── Vitest (optional, requires @vitest/eslint-plugin) ──────────────
+    if (vitest) {
+        const vitestPlugin = await importOptional("@vitest/eslint-plugin");
+        configs.push(createVitestConfig(vitestPlugin));
+    }
+    // ── Fastify (disable conflicting rules) ────────────────────────────
+    if (fastify) {
+        configs.push({
+            name: "axkit/fastify",
+            rules: {
+                "unicorn/prevent-abbreviations": [
+                    "error",
+                    {
+                        allowList: {
+                            app: true,
+                            args: true,
+                            ctx: true,
+                            db: true,
+                            env: true,
+                            err: true,
+                            opts: true,
+                            params: true,
+                            req: true,
+                            res: true,
+                        },
+                    },
+                ],
+                "@typescript-eslint/require-await": "off",
+                "@typescript-eslint/strict-void-return": "off",
+            },
+        });
+    }
     // ── Storybook (after base, before Prettier) ────────────────────────
     if (storybook) {
         const storybookPlugin = (await importOptional("eslint-plugin-storybook"));

package/dist/node-test-config.d.ts

@@ -0,0 +1,8 @@
+import type { Linter } from "eslint";
+/**
+ * Whitelists promise-returning `node:test` functions in the
+ * `no-floating-promises` rule via `allowForKnownSafeCalls`.
+ *
+ * Always applied — harmless if not using `node:test`.
+ */
+export declare const nodeTestConfig: Linter.Config;

package/dist/node-test-config.js

@@ -0,0 +1,27 @@
+/**
+ * Whitelists promise-returning `node:test` functions in the
+ * `no-floating-promises` rule via `allowForKnownSafeCalls`.
+ *
+ * Always applied — harmless if not using `node:test`.
+ */
+export const nodeTestConfig = {
+    name: "axkit/node-test",
+    files: [
+        "**/*.{test,spec}.{ts,tsx,js,mjs,cjs,mts,cts}",
+        "tests/**/*.{ts,tsx,js,mjs,cjs,mts,cts}",
+    ],
+    rules: {
+        "@typescript-eslint/no-floating-promises": [
+            "error",
+            {
+                allowForKnownSafeCalls: [
+                    {
+                        from: "package",
+                        package: "node:test",
+                        name: ["describe", "it", "test", "suite", "todo", "skip", "only"],
+                    },
+                ],
+            },
+        ],
+    },
+};

package/dist/vitest-config.d.ts

@@ -1,2 +1,15 @@
 import type { Linter } from "eslint";
-export declare const vitestConfig: Linter.Config;
+type VitestPlugin = {
+    configs: {
+        recommended: {
+            rules: Linter.RulesRecord;
+        };
+    };
+    environments: {
+        env: {
+            globals: Record<string, boolean>;
+        };
+    };
+};
+export declare function createVitestConfig(vitest: VitestPlugin): Linter.Config;
+export {};

package/dist/vitest-config.js

@@ -1,62 +1,63 @@
-import vitest from "@vitest/eslint-plugin";
-export const vitestConfig = {
-    name: "axkit/vitest",
-    files: [
-        "**/*.{test,spec}.{ts,tsx,js,mjs,cjs,mts,cts}",
-        "tests/**/*.{ts,tsx,js,mjs,cjs,mts,cts}",
-    ],
-    plugins: { vitest },
-    rules: {
-        ...vitest.configs.recommended.rules,
-        // Ensure expect.poll() and expect.element() are awaited
-        "vitest/require-awaited-expect-poll": "error",
-        // Keep vi.mock() and other hoisted APIs at the top of files
-        "vitest/hoisted-apis-on-top": "warn",
-        // Prefer toHaveBeenCalledTimes() matcher
-        "vitest/prefer-to-have-been-called-times": "warn",
-        // Prefer mockResolvedValue() over mockImplementation(() => Promise.resolve())
-        "vitest/prefer-mock-promise-shorthand": "warn",
-        // Prefer expectTypeOf() for type testing
-        "vitest/prefer-expect-type-of": "warn",
-        // Enforce consistent use of .each vs .for for parameterized tests
-        "vitest/consistent-each-for": "warn",
-        // Keep hooks (beforeEach, afterEach, etc.) at the top of describe blocks
-        "vitest/prefer-hooks-on-top": "warn",
-        // ===== Test Logic Errors =====
-        // No conditionals (if/else) inside test bodies - tests should be deterministic
-        "vitest/no-conditional-in-test": "error",
-        // No conditionally defined tests - tests should always run
-        "vitest/no-conditional-tests": "error",
-        // No return statements in tests - just execute assertions
-        "vitest/no-test-return-statement": "warn",
-        // No duplicate lifecycle hooks
-        "vitest/no-duplicate-hooks": "warn",
-        // ===== Better Matchers (auto-fixable) =====
-        // Use toBe() for primitives (strict equality)
-        "vitest/prefer-to-be": "warn",
-        // Use toHaveLength() instead of expect(arr.length).toBe()
-        "vitest/prefer-to-have-length": "warn",
-        // Use toContain() instead of expect(arr.includes()).toBe(true)
-        "vitest/prefer-to-contain": "warn",
-        // Use toBeGreaterThan(), toBeLessThan(), etc.
-        "vitest/prefer-comparison-matcher": "warn",
-        // Use dedicated equality matchers
-        "vitest/prefer-equality-matcher": "warn",
-        // ===== Best Practices =====
-        // Use vi.spyOn() instead of direct property assignment
-        "vitest/prefer-spy-on": "warn",
-        // Use test.todo() for empty/placeholder tests
-        "vitest/prefer-todo": "warn",
-        // Use expect().resolves instead of expect(await promise)
-        "vitest/prefer-expect-resolves": "warn",
-        // No deprecated alias methods (toBeCalled → toHaveBeenCalled)
-        "vitest/no-alias-methods": "warn",
-        // Use vi.mocked() instead of type casting
-        "vitest/prefer-vi-mocked": "warn",
-        // Use .only/.skip instead of f/x prefixes
-        "vitest/no-test-prefixes": "warn",
-    },
-    languageOptions: {
-        globals: { ...vitest.environments.env.globals },
-    },
-};
+export function createVitestConfig(vitest) {
+    return {
+        name: "axkit/vitest",
+        files: [
+            "**/*.{test,spec}.{ts,tsx,js,mjs,cjs,mts,cts}",
+            "tests/**/*.{ts,tsx,js,mjs,cjs,mts,cts}",
+        ],
+        plugins: { vitest },
+        rules: {
+            ...vitest.configs.recommended.rules,
+            // Ensure expect.poll() and expect.element() are awaited
+            "vitest/require-awaited-expect-poll": "error",
+            // Keep vi.mock() and other hoisted APIs at the top of files
+            "vitest/hoisted-apis-on-top": "warn",
+            // Prefer toHaveBeenCalledTimes() matcher
+            "vitest/prefer-to-have-been-called-times": "warn",
+            // Prefer mockResolvedValue() over mockImplementation(() => Promise.resolve())
+            "vitest/prefer-mock-promise-shorthand": "warn",
+            // Prefer expectTypeOf() for type testing
+            "vitest/prefer-expect-type-of": "warn",
+            // Enforce consistent use of .each vs .for for parameterized tests
+            "vitest/consistent-each-for": "warn",
+            // Keep hooks (beforeEach, afterEach, etc.) at the top of describe blocks
+            "vitest/prefer-hooks-on-top": "warn",
+            // ===== Test Logic Errors =====
+            // No conditionals (if/else) inside test bodies - tests should be deterministic
+            "vitest/no-conditional-in-test": "error",
+            // No conditionally defined tests - tests should always run
+            "vitest/no-conditional-tests": "error",
+            // No return statements in tests - just execute assertions
+            "vitest/no-test-return-statement": "warn",
+            // No duplicate lifecycle hooks
+            "vitest/no-duplicate-hooks": "warn",
+            // ===== Better Matchers (auto-fixable) =====
+            // Use toBe() for primitives (strict equality)
+            "vitest/prefer-to-be": "warn",
+            // Use toHaveLength() instead of expect(arr.length).toBe()
+            "vitest/prefer-to-have-length": "warn",
+            // Use toContain() instead of expect(arr.includes()).toBe(true)
+            "vitest/prefer-to-contain": "warn",
+            // Use toBeGreaterThan(), toBeLessThan(), etc.
+            "vitest/prefer-comparison-matcher": "warn",
+            // Use dedicated equality matchers
+            "vitest/prefer-equality-matcher": "warn",
+            // ===== Best Practices =====
+            // Use vi.spyOn() instead of direct property assignment
+            "vitest/prefer-spy-on": "warn",
+            // Use test.todo() for empty/placeholder tests
+            "vitest/prefer-todo": "warn",
+            // Use expect().resolves instead of expect(await promise)
+            "vitest/prefer-expect-resolves": "warn",
+            // No deprecated alias methods (toBeCalled → toHaveBeenCalled)
+            "vitest/no-alias-methods": "warn",
+            // Use vi.mocked() instead of type casting
+            "vitest/prefer-vi-mocked": "warn",
+            // Use .only/.skip instead of f/x prefixes
+            "vitest/no-test-prefixes": "warn",
+        },
+        languageOptions: {
+            globals: { ...vitest.environments.env.globals },
+        },
+    };
+}

package/package.json

@@ -2,8 +2,8 @@
   "name": "eslint-config-axkit",
   "author": "Łukasz Jerciński",
   "license": "MIT",
-  "version": "1.4.0",
-  "description": "Reusable ESLint flat config for TypeScript + Node.js projects with strict type checking, Prettier, Unicorn, and Vitest",
+  "version": "1.6.0",
+  "description": "Reusable ESLint flat config for TypeScript + Node.js projects with strict type checking, Prettier, and Unicorn",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Jercik/eslint-config-axkit.git"
@@ -53,7 +53,7 @@
     "vitest",
     "axkit"
   ],
-  "packageManager": "pnpm@10.30.1",
+  "packageManager": "pnpm@10.30.3",
   "engines": {
     "node": ">=22.14.0"
   },
@@ -61,7 +61,8 @@
     "eslint": ">=10",
     "eslint-config-next": ">=16",
     "eslint-plugin-better-tailwindcss": ">=4",
-    "eslint-plugin-storybook": ">=10"
+    "eslint-plugin-storybook": ">=10",
+    "@vitest/eslint-plugin": ">=1"
   },
   "peerDependenciesMeta": {
     "eslint-config-next": {
@@ -72,25 +73,27 @@
     },
     "eslint-plugin-storybook": {
       "optional": true
+    },
+    "@vitest/eslint-plugin": {
+      "optional": true
     }
   },
   "dependencies": {
-    "@eslint/compat": "^2.0.2",
+    "@eslint/compat": "^2.0.3",
     "@eslint/js": "^10.0.1",
-    "@vitest/eslint-plugin": "^1.6.9",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-unicorn": "^63.0.0",
-    "globals": "^17.3.0",
-    "typescript-eslint": "^8.56.0"
+    "globals": "^17.4.0",
+    "typescript-eslint": "^8.56.1"
   },
   "devDependencies": {
     "@total-typescript/ts-reset": "^0.6.1",
-    "@types/node": "^25.3.0",
+    "@types/node": "^25.3.5",
     "@vitest/coverage-v8": "^4.0.18",
-    "eslint": "^10.0.0",
+    "eslint": "^10.0.3",
     "fta-check": "^1.5.1",
     "fta-cli": "^3.0.0",
-    "knip": "^5.84.1",
+    "knip": "^5.85.0",
     "prettier": "3.8.1",
     "semantic-release": "^25.0.3",
     "typescript": "^5.9.3",