@shufflies/eslint-config 1.0.0 → 1.0.2

package/README.md

@@ -8,7 +8,7 @@ It's my own personal set of reusable eslint configuration.
 Install the package:
 
 ```shell
-pnpm i -D @shufflies/eslint-config
+npm install -D @shufflies/eslint-config
 ```
 
 Reference it in an `eslint.config.mjs` or `eslint.config.ts`:
@@ -23,6 +23,13 @@ import { defineConfig } from "eslint/config";
 export default defineConfig(
   ...recommended({
     gitignorePaths: [fileURLToPath(new URL(".gitignore", import.meta.url))],
-  })
+  }),
+
+  // Other rule/config overrides
+  {
+    rules: {
+      "some/rule": "off"
+    }
+  }
 );
 ```

package/lib/cjs/configs.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recommended = recommended;
+const compat_1 = require("@eslint/compat");
+const js_1 = __importDefault(require("@eslint/js"));
+const eslint_plugin_simple_import_sort_1 = __importDefault(require("eslint-plugin-simple-import-sort"));
+const eslint_plugin_unicorn_1 = __importDefault(require("eslint-plugin-unicorn"));
+const typescript_eslint_1 = __importDefault(require("typescript-eslint"));
+function recommended(args = {}) {
+    const { gitignorePaths = [] } = args;
+    const gitIgnores = gitignorePaths.map((gitIgnorePath) => {
+        const ignoreConfig = (0, compat_1.includeIgnoreFile)(gitIgnorePath);
+        return ignoreConfig.ignores;
+    });
+    const result = [
+        {
+            ignores: gitIgnores.flat(),
+        },
+        js_1.default.configs.recommended,
+        typescript_eslint_1.default.configs.recommended,
+        eslint_plugin_unicorn_1.default.configs.recommended,
+        {
+            rules: {
+                "unicorn/filename-case": "off",
+            },
+        },
+        {
+            plugins: {
+                "simple-import-sort": eslint_plugin_simple_import_sort_1.default,
+            },
+            rules: {
+                // ✅ Prefer and autofix to `import type`
+                "@typescript-eslint/consistent-type-imports": [
+                    "error",
+                    {
+                        prefer: "type-imports",
+                        disallowTypeAnnotations: false,
+                    },
+                ],
+                // ✅ Group + sort import lines, sort named specifiers
+                "simple-import-sort/imports": "error",
+                "simple-import-sort/exports": "error",
+                // ✅ Good hygiene
+                "no-duplicate-imports": "error",
+            },
+        },
+        {
+            rules: {
+                "@typescript-eslint/no-empty-object-type": "off",
+                "@typescript-eslint/no-unused-vars": [
+                    "error",
+                    {
+                        args: "all",
+                        argsIgnorePattern: "^_",
+                        caughtErrors: "all",
+                        caughtErrorsIgnorePattern: "^_",
+                        destructuredArrayIgnorePattern: "^_",
+                        varsIgnorePattern: "^_",
+                        ignoreRestSiblings: true,
+                    },
+                ],
+            },
+        },
+    ];
+    return result;
+}

package/lib/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recommended = void 0;
+var configs_js_1 = require("./configs.js");
+Object.defineProperty(exports, "recommended", { enumerable: true, get: function () { return configs_js_1.recommended; } });

package/lib/esm/configs.js

@@ -0,0 +1,63 @@
+import { includeIgnoreFile } from "@eslint/compat";
+import eslint from "@eslint/js";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+import eslintPluginUnicorn from "eslint-plugin-unicorn";
+import tseslint from "typescript-eslint";
+export function recommended(args = {}) {
+    const { gitignorePaths = [] } = args;
+    const gitIgnores = gitignorePaths.map((gitIgnorePath) => {
+        const ignoreConfig = includeIgnoreFile(gitIgnorePath);
+        return ignoreConfig.ignores;
+    });
+    const result = [
+        {
+            ignores: gitIgnores.flat(),
+        },
+        eslint.configs.recommended,
+        tseslint.configs.recommended,
+        eslintPluginUnicorn.configs.recommended,
+        {
+            rules: {
+                "unicorn/filename-case": "off",
+            },
+        },
+        {
+            plugins: {
+                "simple-import-sort": simpleImportSort,
+            },
+            rules: {
+                // ✅ Prefer and autofix to `import type`
+                "@typescript-eslint/consistent-type-imports": [
+                    "error",
+                    {
+                        prefer: "type-imports",
+                        disallowTypeAnnotations: false,
+                    },
+                ],
+                // ✅ Group + sort import lines, sort named specifiers
+                "simple-import-sort/imports": "error",
+                "simple-import-sort/exports": "error",
+                // ✅ Good hygiene
+                "no-duplicate-imports": "error",
+            },
+        },
+        {
+            rules: {
+                "@typescript-eslint/no-empty-object-type": "off",
+                "@typescript-eslint/no-unused-vars": [
+                    "error",
+                    {
+                        args: "all",
+                        argsIgnorePattern: "^_",
+                        caughtErrors: "all",
+                        caughtErrorsIgnorePattern: "^_",
+                        destructuredArrayIgnorePattern: "^_",
+                        varsIgnorePattern: "^_",
+                        ignoreRestSiblings: true,
+                    },
+                ],
+            },
+        },
+    ];
+    return result;
+}

package/lib/esm/index.js

@@ -0,0 +1 @@
+export { recommended } from "./configs.js";

package/lib/types/configs.d.ts

@@ -0,0 +1,5 @@
+import { type FlatConfig } from "@eslint/compat";
+export interface RecommendedConfigArgs {
+    gitignorePaths?: string[];
+}
+export declare function recommended(args?: RecommendedConfigArgs): ReadonlyArray<FlatConfig>;

package/lib/types/index.d.ts

@@ -0,0 +1,2 @@
+export { recommended } from "./configs.js";
+export type { RecommendedConfigArgs } from "./configs.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shufflies/eslint-config",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "type": "module",
   "exports": {
@@ -14,11 +14,12 @@
     "lib"
   ],
   "scripts": {
-    "prepare": "husky install",
+    "prepare": "husky",
     "clean": "rimraf lib",
-    "build:types": "tsc --declaration --emitDeclarationOnly --outDir lib/types -p .",
-    "build:cjs": "tsc --module commonjs --outDir lib/cjs -p .",
-    "build:esm": "tsc --module nodenext --outDir lib/esm -p .",
+    "test": "eslint test --config test/eslint.config.mjs --report-unused-disable-directives",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir lib/types -p src",
+    "build:cjs": "tsc --module commonjs --outDir lib/cjs -p src",
+    "build:esm": "tsc --module nodenext --outDir lib/esm -p src",
     "build": "zx scripts/build.mjs"
   },
   "keywords": [
@@ -27,7 +28,7 @@
   ],
   "author": "Royston Shufflebotham",
   "license": "MIT",
-  "packageManager": "pnpm@10.11.0",
+  "packageManager": "npm@11.4.2",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -43,7 +44,6 @@
     "@commitlint/cli": "^19.8.1",
     "@commitlint/config-conventional": "^19.8.1",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^11.0.3",
     "@semantic-release/npm": "^12.0.1",
     "@types/node": "^24.0.1",