eslint-config-axkit 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Łukasz Jerciński
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# eslint-config-axkit
+
+Reusable ESLint flat config for TypeScript + Node.js projects with strict type checking, Prettier, Unicorn, and Vitest.
+
+## Quick Start
+
+```bash
+# Install
+npm install -D eslint eslint-config-axkit
+```
+
+Create an `eslint.config.js` in your project root:
+
+```js
+import path from "node:path";
+import { axkit } from "eslint-config-axkit";
+
+const gitignorePath = path.join(import.meta.dirname, ".gitignore");
+
+export default axkit({ gitignorePath });
+```
+
+```bash
+# Run
+npx eslint .
+```
+
+## Installation
+
+```bash
+# npm
+npm install -D eslint eslint-config-axkit
+
+# pnpm
+pnpm add -D eslint eslint-config-axkit
+```
+
+## Configuration
+
+Create an `eslint.config.js` in your project root:
+
+```js
+import path from "node:path";
+import { axkit } from "eslint-config-axkit";
+
+const gitignorePath = path.join(import.meta.dirname, ".gitignore");
+
+export default axkit({ gitignorePath });
+```
+
+Or without gitignore integration:
+
+```js
+import { axkit } from "eslint-config-axkit";
+
+export default axkit();
+```
+
+## What's Included
+
+For the current rule set and presets, see the source code in `src/`.
+
+## Extending the Config
+
+Add additional rules or override existing ones by spreading additional config objects:
+
+```js
+import path from "node:path";
+import { axkit } from "eslint-config-axkit";
+
+const gitignorePath = path.join(import.meta.dirname, ".gitignore");
+
+export default [
+  ...axkit({ gitignorePath }),
+  {
+    rules: {
+      // Your custom rules
+      "no-console": "warn",
+    },
+  },
+];
+```
+
+## Options
+
+| Option          | Type     | Description                                                                |
+| --------------- | -------- | -------------------------------------------------------------------------- |
+| `gitignorePath` | `string` | Path to `.gitignore` file. Patterns will be added to ESLint's ignore list. |
+
+## Requirements
+
+- Node.js >= 22.14.0
+- ESLint >= 9
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import type { Linter } from "eslint";
+export type Options = {
+    /**
+     * Path to .gitignore file. If provided, patterns from this file
+     * will be added to ESLint's ignore list.
+     */
+    gitignorePath?: string;
+};
+/**
+ * Creates a complete ESLint flat config for TypeScript + Node.js projects.
+ *
+ * Includes:
+ * - ESLint recommended rules
+ * - TypeScript strict type checking
+ * - Unicorn plugin (recommended)
+ * - Vitest plugin for test files
+ * - Prettier compatibility (disables conflicting rules)
+ */
+export declare function axkit(options?: Options): Linter.Config[];
+export default axkit;

package/dist/index.js

@@ -0,0 +1,87 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { includeIgnoreFile } from "@eslint/compat";
+import eslintConfigPrettier from "eslint-config-prettier/flat";
+import vitest from "@vitest/eslint-plugin";
+import eslintPluginUnicorn from "eslint-plugin-unicorn";
+/**
+ * Creates a complete ESLint flat config for TypeScript + Node.js projects.
+ *
+ * Includes:
+ * - ESLint recommended rules
+ * - TypeScript strict type checking
+ * - Unicorn plugin (recommended)
+ * - Vitest plugin for test files
+ * - Prettier compatibility (disables conflicting rules)
+ */
+export function axkit(options = {}) {
+    const { gitignorePath } = options;
+    const configs = [];
+    if (gitignorePath) {
+        configs.push(includeIgnoreFile(gitignorePath, "Copy patterns from .gitignore"));
+    }
+    configs.push(
+    // ESLint recommended
+    js.configs.recommended, 
+    // TypeScript strict type checking
+    ...tseslint.configs.strictTypeChecked, 
+    // Base config for all JS/TS files
+    {
+        name: "axkit/base",
+        files: ["**/*.{js,mjs,cjs,ts,tsx,mts,cts}"],
+        languageOptions: {
+            globals: globals.node,
+            parserOptions: {
+                projectService: true,
+            },
+        },
+        rules: {
+            // Security rules
+            "no-eval": "error",
+            "no-new-func": "error",
+            "no-script-url": "error",
+            // Correctness rules
+            "no-return-assign": ["error", "always"],
+            radix: ["error", "as-needed"],
+            "guard-for-in": "error",
+            "prefer-object-has-own": "error",
+            // Clarity rules
+            "prefer-regex-literals": ["error", { disallowRedundantWrapping: true }],
+            "require-unicode-regexp": "error",
+            "no-extend-native": "error",
+            "no-new-wrappers": "error",
+            "no-implicit-coercion": ["error", { allow: ["!!"] }],
+            // Allow numbers in template literals (safe and common)
+            "@typescript-eslint/restrict-template-expressions": [
+                "error",
+                { allowNumber: true },
+            ],
+        },
+    }, 
+    // Unicorn plugin recommended config
+    eslintPluginUnicorn.configs.recommended, 
+    // Disable type-checking for config files
+    {
+        name: "axkit/config-files",
+        files: ["*.config.{js,ts,mjs,mts}"],
+        ...tseslint.configs.disableTypeChecked,
+    }, 
+    // Vitest rules for test files
+    {
+        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,
+        languageOptions: {
+            globals: { ...vitest.environments.env.globals },
+        },
+    }, 
+    // Prettier compatibility (must be last)
+    eslintConfigPrettier);
+    return configs;
+}
+export default axkit;

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "eslint-config-axkit",
+  "author": "Łukasz Jerciński",
+  "license": "MIT",
+  "version": "1.0.0",
+  "description": "Reusable ESLint flat config for TypeScript + Node.js projects with strict type checking, Prettier, Unicorn, and Vitest",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Jercik/eslint-config-axkit.git"
+  },
+  "homepage": "https://github.com/Jercik/eslint-config-axkit#readme",
+  "bugs": {
+    "url": "https://github.com/Jercik/eslint-config-axkit/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config",
+    "flat-config",
+    "typescript",
+    "prettier",
+    "unicorn",
+    "vitest",
+    "axkit"
+  ],
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=9"
+  },
+  "dependencies": {
+    "@eslint/compat": "^2.0.0",
+    "@eslint/js": "^9.39.2",
+    "@vitest/eslint-plugin": "^1.6.5",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "globals": "^17.0.0",
+    "typescript-eslint": "^8.52.0"
+  },
+  "devDependencies": {
+    "@total-typescript/ts-reset": "^0.6.1",
+    "@types/node": "^25.0.3",
+    "@vitest/coverage-v8": "^4.0.16",
+    "eslint": "^9.39.2",
+    "fta-check": "^1.5.1",
+    "fta-cli": "^3.0.0",
+    "knip": "^5.80.0",
+    "prettier": "3.7.4",
+    "semantic-release": "^25.0.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.app.json",
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "fta": "fta-check",
+    "knip": "knip",
+    "lint": "eslint",
+    "rebuild": "pnpm run clean && pnpm run build",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "typecheck": "tsc -b --noEmit"
+  }
+}