@will-stone/eslint-config 10.0.2 → 11.0.1

package/dist/index.d.ts

@@ -1,16 +1,23 @@
-import { Linter } from 'eslint';
+import { Linter } from '@typescript-eslint/utils/ts-eslint';
 
 type Options = {
-    /**
-     * When this option is provided, type-aware rules will be enabled.
-     * @see https://typescript-eslint.io/linting/typed-linting/
-     */
-    readonly tsconfigPath?: string | readonly string[];
+    readonly astro?: boolean;
+    readonly jest?: boolean;
+    readonly react?: boolean;
+    readonly tailwind?: boolean;
+    readonly typescript?: boolean | {
+        /**
+         * When this option is provided, type-aware rules will be enabled.
+         * @see https://typescript-eslint.io/linting/typed-linting/
+         */
+        tsconfigPath?: string | readonly string[];
+    };
+    readonly vitest?: boolean;
 };
 
 /**
  * Construct an array of ESLint flat config items.
  */
-declare function factory(options?: Options): Linter.FlatConfig[];
+declare function factory(options?: Options): Linter.ConfigType[];
 
 export { factory as default };

package/dist/index.js

@@ -1,6 +1,3 @@
-// src/factory.ts
-import gitignore from "eslint-config-flat-gitignore";
-
 // src/configs/astro.ts
 import parserTypescript from "@typescript-eslint/parser";
 import parserAstro from "astro-eslint-parser";
@@ -344,6 +341,9 @@ function base() {
   ];
 }
 
+// src/configs/ignores.ts
+import gitignore from "eslint-config-flat-gitignore";
+
 // src/globs.ts
 var GLOB_EXCLUDE = [
   "**/node_modules",
@@ -378,6 +378,13 @@ function ignores() {
     {
       ignores: GLOB_EXCLUDE,
       name: "will-stone/ignores"
+    },
+    {
+      name: "will-stone/git-ignores",
+      ...gitignore({
+        // Prevent throw if gitignore not found.
+        strict: false
+      })
     }
   ];
 }
@@ -539,13 +546,9 @@ import globals3 from "globals";
 function node() {
   return [
     {
-      languageOptions: {
-        globals: globals3.node
-      },
+      languageOptions: { globals: globals3.node },
       name: "will-stone/node",
-      plugins: {
-        n: pluginNode
-      },
+      plugins: { n: pluginNode },
       rules: {
         "n/callback-return": "error",
         "n/global-require": "error",
@@ -596,6 +599,7 @@ function node() {
 }
 
 // src/configs/react.ts
+import { fixupPluginRules } from "@eslint/compat";
 import pluginJsxA11y from "eslint-plugin-jsx-a11y";
 import pluginReact from "eslint-plugin-react";
 import pluginReactHooks from "eslint-plugin-react-hooks";
@@ -616,7 +620,7 @@ function react() {
       plugins: {
         "jsx-a11y": pluginJsxA11y,
         react: pluginReact,
-        "react-hooks": pluginReactHooks
+        "react-hooks": fixupPluginRules(pluginReactHooks)
       },
       rules: {
         "jsx-a11y/alt-text": "error",
@@ -920,23 +924,26 @@ function tailwind() {
 // src/configs/typescript.ts
 import pluginTypescript from "@typescript-eslint/eslint-plugin";
 import * as parserTypescript2 from "@typescript-eslint/parser";
-function typescript(options) {
-  const tsconfigPath = options?.tsconfigPath ? Array.isArray(options.tsconfigPath) ? options.tsconfigPath : [options.tsconfigPath] : void 0;
+function typescript(rawOptions) {
+  const options = !rawOptions || typeof rawOptions === "boolean" ? {} : rawOptions;
   return [
     {
       files: ["**/*.{ts,tsx,astro}"],
       languageOptions: {
         parser: parserTypescript2,
         parserOptions: {
-          ...tsconfigPath ? {
-            project: tsconfigPath,
+          ...options.tsconfigPath ? {
+            projectService: {
+              allowDefaultProject: ["./*.js"],
+              defaultProject: options.tsconfigPath
+            },
             tsconfigRootDir: process.cwd()
           } : {}
         }
       },
       name: "will-stone/typescript",
       plugins: {
-        // @ts-expect-error -- does not confirm to type
+        // @ts-expect-error -- is using classic config type instead of flat config.
         "@typescript-eslint": pluginTypescript
       },
       rules: {
@@ -1009,7 +1016,7 @@ function typescript(options) {
         /**
          * These require type checking
          */
-        ...tsconfigPath ? {
+        ...options?.tsconfigPath ? {
           "@typescript-eslint/await-thenable": "off",
           "@typescript-eslint/consistent-return": "off",
           "@typescript-eslint/consistent-type-exports": "warn",
@@ -1158,9 +1165,7 @@ function unicorn() {
   return [
     {
       name: "will-stone/unicorn",
-      plugins: {
-        unicorn: pluginUnicorn
-      },
+      plugins: { unicorn: pluginUnicorn },
       rules: {
         // This rule is superseded by the unicorn version below
         "no-nested-ternary": "off",
@@ -1313,69 +1318,120 @@ function unicorn() {
   ];
 }
 
+// src/configs/vitest.ts
+import { fixupPluginRules as fixupPluginRules2 } from "@eslint/compat";
+import pluginVitest from "eslint-plugin-vitest";
+function vitest() {
+  return [
+    {
+      files: ["**/*.{spec,test}.{js,cjs,mjs,jsx,ts,tsx}"],
+      name: "will-stone/vitest",
+      plugins: { vitest: fixupPluginRules2(pluginVitest) },
+      rules: {
+        // For now, I will turn on all rules and tweak them below.
+        ...pluginVitest.configs.all.rules,
+        // Expect as much as you like. Is there any benefit to limiting this?
+        "vitest/max-expects": "off",
+        // The lifecycle hooks, like `beforeEach`, can be useful. I could move
+        // to setup and teardown functions, but not sure yet.
+        "vitest/no-hooks": "off",
+        // Every test must have an expect, this is covered by expect-expect rule.
+        "vitest/prefer-expect-assertions": "off",
+        // These two could be dangerous as you may actually want to ensure that
+        // something is exactly `false` or `true`, and not something that
+        // equates to that if run through Boolean().
+        "vitest/prefer-to-be-falsy": "off",
+        "vitest/prefer-to-be-truthy": "off",
+        // No need to nest everything in useless describe blocks:
+        "vitest/require-top-level-describe": "off"
+      }
+    }
+  ];
+}
+
 // src/utils.ts
-import { existsSync, readFileSync } from "fs";
-import { globSync } from "glob";
-function checkEnvironment() {
-  const isGitIgnore = existsSync(".gitignore");
-  let isNodeEngine = false;
-  let isTailwind = false;
-  let testingFramework = null;
-  const allPackageJsonPaths = globSync("**/package.json", {
-    ignore: "**/node_modules/**"
-  });
+import { readFileSync } from "fs";
+import { globbySync } from "globby";
+function checkDepsExist(depNames) {
+  const depCount = depNames.length;
+  const allPackageJsonPaths = globbySync([
+    "**/package.json",
+    "!**/node_modules/**"
+  ]);
+  const hasPackageMap = {};
+  let foundCount = 0;
   for (const packageJsonPath of allPackageJsonPaths) {
     const buffer = readFileSync(packageJsonPath);
     const data = new TextDecoder().decode(buffer);
-    const packageJson = JSON.parse(data);
-    if (!testingFramework && Boolean(
-      packageJson.dependencies?.jest || packageJson.devDependencies?.jest
-    )) {
-      testingFramework = "jest";
-    }
-    if (!isNodeEngine && Boolean(packageJson.engines?.node)) {
-      isNodeEngine = true;
+    const package_ = JSON.parse(data);
+    for (const depName of depNames) {
+      if (package_ && (package_.dependencies?.[depName] || package_.devDependencies?.[depName])) {
+        hasPackageMap[depName] = true;
+        foundCount = foundCount + 1;
+        if (foundCount === depCount) {
+          break;
+        }
+      }
     }
-    if (!isTailwind && Boolean(
-      packageJson.dependencies?.tailwindcss || packageJson.devDependencies?.tailwindcss
-    )) {
-      isTailwind = true;
+    if (foundCount === depCount) {
+      break;
     }
   }
-  const isNode = isNodeEngine || existsSync(".nvmrc") || existsSync(".node-version");
-  return {
-    isGitIgnore,
-    isNode,
-    isTailwind,
-    testingFramework
-  };
+  return hasPackageMap;
 }
 
 // src/factory.ts
 function factory(options) {
-  const { isGitIgnore, isNode, isTailwind, testingFramework } = checkEnvironment();
   const configs = [];
-  if (isGitIgnore) {
-    configs.push([gitignore()]);
+  configs.push(ignores(), base(), imports(), unicorn(), node());
+  const packageExists = checkDepsExist([
+    "typescript",
+    "astro",
+    "react",
+    "tailwind",
+    "jest",
+    "vitest"
+  ]);
+  const isAtLeastOnePackageExists = Object.values(packageExists).some(Boolean);
+  if (isAtLeastOnePackageExists) {
+    console.log("Auto configured plugins:");
+  }
+  if (packageExists.typescript) {
+    console.log("  - TypeScript");
   }
-  configs.push(
-    ignores(),
-    base(),
-    imports(),
-    unicorn(),
-    typescript(options),
-    astro(),
-    react()
-  );
-  if (isNode) {
-    configs.push(node());
+  if (packageExists.typescript || options?.typescript || process.env.INSPECTOR) {
+    configs.push(typescript(options?.typescript));
   }
-  if (isTailwind) {
+  if (packageExists.astro) {
+    console.log("  - Astro");
+  }
+  if (packageExists.astro || options?.astro || process.env.INSPECTOR) {
+    configs.push(astro());
+  }
+  if (packageExists.react) {
+    console.log("  - React");
+  }
+  if (packageExists.react || options?.react || process.env.INSPECTOR) {
+    configs.push(react());
+  }
+  if (packageExists.tailwind) {
+    console.log("  - Tailwind");
+  }
+  if (packageExists.tailwind || options?.tailwind || process.env.INSPECTOR) {
     configs.push(tailwind());
   }
-  if (testingFramework === "jest") {
+  if (packageExists.jest) {
+    console.log("  - Tailwind");
+  }
+  if (packageExists.jest || options?.jest || process.env.INSPECTOR) {
     configs.push(jest());
   }
+  if (packageExists.vitest) {
+    console.log("  - Vitest");
+  }
+  if (packageExists.vitest || options?.vitest || process.env.INSPECTOR) {
+    configs.push(vitest());
+  }
   const merged = configs.flat();
   return merged;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@will-stone/eslint-config",
-  "version": "10.0.2",
+  "version": "11.0.1",
   "description": "Will Stone's ESLint config",
   "keywords": [
     "eslint-config"
@@ -25,8 +25,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --clean --dts --cjsInterop --splitting",
-    "dev": "tsup src/index.ts --format esm,cjs --watch & config-inspector",
+    "build": "tsup src/index.ts --format esm --clean --dts",
+    "dev": "tsup src/index.ts --format esm --watch & INSPECTOR=true config-inspector",
     "lint": "npm run stub && eslint .",
     "prepare": "husky",
     "prepublishOnly": "npm run build",
@@ -44,23 +44,26 @@
   },
   "prettier": "@will-stone/prettier-config",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
+    "@eslint/compat": "^1.1.1",
+    "@typescript-eslint/eslint-plugin": "^8.0.1",
+    "@typescript-eslint/parser": "^8.0.1",
     "astro-eslint-parser": "^1.0.2",
     "confusing-browser-globals": "^1.0.11",
     "eslint-config-flat-gitignore": "^0.1.8",
     "eslint-plugin-astro": "^1.2.3",
     "eslint-plugin-import-x": "^3.1.0",
-    "eslint-plugin-jest": "^28.7.0",
+    "eslint-plugin-jest": "^28.8.0",
     "eslint-plugin-jsx-a11y": "^6.9.0",
-    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-react": "^7.35.0",
     "eslint-plugin-react-hooks": "^4.6.2",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-tailwindcss": "^3.17.4",
     "eslint-plugin-unicorn": "^55.0.0",
-    "glob": "^11.0.0",
-    "globals": "^15.9.0"
+    "eslint-plugin-vitest": "^0.5.4",
+    "globals": "^15.9.0",
+    "globby": "^14.0.2",
+    "type-fest": "^4.24.0"
   },
   "devDependencies": {
     "@commits-with-character/conventional-changelog-preset": "^0.2.2",
@@ -68,20 +71,20 @@
     "@release-it/conventional-changelog": "^8.0.1",
     "@types/confusing-browser-globals": "^1.0.3",
     "@types/eslint": "^9.6.0",
-    "@types/node": "^22.1.0",
+    "@types/node": "^22.2.0",
+    "@typescript-eslint/utils": "^8.0.1",
     "@will-stone/prettier-config": "^8.0.1",
     "husky": "^9.1.4",
     "lint-staged": "^15.2.8",
     "prettier": "^3.3.3",
     "release-it": "^17.6.0",
     "tsup": "^8.2.4",
-    "type-fest": "^4.23.0",
     "typescript": "^5.5.4"
   },
   "peerDependencies": {
-    "eslint": ">=9.8.0"
+    "eslint": ">=9.9.0"
   },
   "overrides": {
-    "eslint": ">=9.8.0"
+    "eslint": ">=9.9.0"
   }
 }