@will-stone/eslint-config 11.0.2 → 11.0.3

package/dist/index.d.ts

@@ -1,23 +1,23 @@
 import { Linter } from '@typescript-eslint/utils/ts-eslint';
 
+/**
+ * This is a set of optional features that can be turned on.
+ */
 type Options = {
-    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;
+    astro?: boolean;
+    jest?: boolean;
+    react?: boolean;
+    tailwind?: {
+        config?: string;
+        cssFiles?: string[];
+    } | boolean;
+    typescript?: boolean;
+    vitest?: boolean;
 };
 
 /**
  * Construct an array of ESLint flat config items.
  */
-declare function factory(options?: Options): Linter.ConfigType[];
+declare function config(options?: Options): Linter.ConfigType[];
 
-export { factory as default };
+export { config as default };

package/dist/index.js

@@ -2,7 +2,7 @@
 import parserTypescript from "@typescript-eslint/parser";
 import parserAstro from "astro-eslint-parser";
 import pluginAstro from "eslint-plugin-astro";
-function astro() {
+function astro(_options) {
   return [
     {
       files: ["**/*.astro"],
@@ -380,7 +380,7 @@ function ignores() {
       name: "will-stone/ignores"
     },
     {
-      name: "will-stone/git-ignores",
+      name: "will-stone/git-ignore",
       ...gitignore({
         // Prevent throw if gitignore not found.
         strict: false
@@ -459,7 +459,7 @@ function imports() {
 // src/configs/jest.ts
 import pluginJest from "eslint-plugin-jest";
 import globals2 from "globals";
-function jest() {
+function jest(_options) {
   return [
     {
       files: ["**/__mocks__/**/*", "**/*.{spec,test}.{js,cjs,mjs,jsx,ts,tsx}"],
@@ -604,7 +604,7 @@ import pluginJsxA11y from "eslint-plugin-jsx-a11y";
 import pluginReact from "eslint-plugin-react";
 import pluginReactHooks from "eslint-plugin-react-hooks";
 import globals4 from "globals";
-function react() {
+function react(_options) {
   return [
     {
       files: ["**/*.{jsx,tsx}"],
@@ -902,7 +902,8 @@ function react() {
 
 // src/configs/tailwind.ts
 import pluginTailwind from "eslint-plugin-tailwindcss";
-function tailwind() {
+function tailwind(rawOptions) {
+  const options = !rawOptions || rawOptions === true ? {} : rawOptions;
   return [
     {
       files: ["**/*.{jsx,tsx,astro}"],
@@ -916,6 +917,19 @@ function tailwind() {
         "tailwindcss/no-arbitrary-value": "off",
         "tailwindcss/no-contradicting-classname": "warn",
         "tailwindcss/no-custom-classname": "error"
+      },
+      settings: {
+        tailwindcss: {
+          config: options.config,
+          /**
+           * Default to no custom CSS files, due to performance issue with the
+           * plugin can be somewhat mitigated by setting this config to `[]` so
+           * that cssFiles do not need to be found automatically.
+           * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/276
+           * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/174
+           */
+          cssFiles: options.cssFiles || []
+        }
       }
     }
   ];
@@ -1321,7 +1335,7 @@ function unicorn() {
 // src/configs/vitest.ts
 import { fixupPluginRules as fixupPluginRules2 } from "@eslint/compat";
 import pluginVitest from "eslint-plugin-vitest";
-function vitest() {
+function vitest(_options) {
   return [
     {
       files: ["**/*.{spec,test}.{js,cjs,mjs,jsx,ts,tsx}"],
@@ -1349,7 +1363,54 @@ function vitest() {
   ];
 }
 
-// src/utils.ts
+// src/configs/index.ts
+var defaultConfigs = [
+  { config: ignores, name: "Ignores" },
+  { config: base, name: "Base" },
+  { config: imports, name: "Imports" },
+  { config: unicorn, name: "Unicorn" },
+  { config: node, name: "Node" }
+];
+var autoConfigs = [
+  {
+    config: astro,
+    dep: "astro",
+    name: "Astro.js",
+    optionName: "astro"
+  },
+  {
+    config: jest,
+    dep: "jest",
+    name: "Jest",
+    optionName: "jest"
+  },
+  {
+    config: react,
+    dep: "react",
+    name: "React",
+    optionName: "react"
+  },
+  {
+    config: tailwind,
+    dep: "tailwindcss",
+    name: "Tailwind",
+    optionName: "tailwind"
+  },
+  {
+    config: typescript,
+    dep: "typescript",
+    name: "Typescript",
+    optionName: "typescript"
+  },
+  {
+    config: vitest,
+    dep: "vitest",
+    name: "Vitest",
+    optionName: "vitest"
+  }
+];
+
+// src/utils/check-deps-exist.ts
 import { readFileSync } from "fs";
 import { globbySync } from "globby";
 function checkDepsExist(depNames) {
@@ -1359,6 +1420,9 @@ function checkDepsExist(depNames) {
     "!**/node_modules/**"
   ]);
   const hasPackageMap = {};
+  for (const depName of depNames) {
+    hasPackageMap[depName] = false;
+  }
   let foundCount = 0;
   for (const packageJsonPath of allPackageJsonPaths) {
     const buffer = readFileSync(packageJsonPath);
@@ -1380,61 +1444,33 @@ function checkDepsExist(depNames) {
   return hasPackageMap;
 }
 
-// src/factory.ts
-function factory(options) {
+// src/index.ts
+function config(options) {
   const configs = [];
-  configs.push(ignores(), base(), imports(), unicorn(), node());
-  const packageExists = checkDepsExist([
-    "typescript",
-    "astro",
-    "react",
-    "tailwindcss",
-    "jest",
-    "vitest"
-  ]);
-  const isAtLeastOnePackageExists = Object.values(packageExists).some(Boolean);
-  if (isAtLeastOnePackageExists) {
-    console.log("Auto configured plugins:");
-  }
-  if (packageExists.typescript) {
-    console.log("  - TypeScript");
-  }
-  if (packageExists.typescript || options?.typescript || process.env.INSPECTOR) {
-    configs.push(typescript(options?.typescript));
-  }
-  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.tailwindcss) {
-    console.log("  - Tailwind");
-  }
-  if (packageExists.tailwindcss || options?.tailwind || process.env.INSPECTOR) {
-    configs.push(tailwind());
-  }
-  if (packageExists.jest) {
-    console.log("  - Tailwind");
-  }
-  if (packageExists.jest || options?.jest || process.env.INSPECTOR) {
-    configs.push(jest());
+  const autoConfigDeps = Object.values(autoConfigs).map(({ dep }) => dep);
+  const existingAutoConfigDeps = checkDepsExist(autoConfigDeps);
+  for (const defaultConfig of defaultConfigs) {
+    configs.push(defaultConfig.config());
   }
-  if (packageExists.vitest) {
-    console.log("  - Vitest");
+  const enabledAutoConfigs = autoConfigs.filter(({ dep, optionName }) => {
+    return (
+      // Is forced on.
+      options?.[optionName] || // Is present and not forced off.
+      existingAutoConfigDeps[dep] && options?.[optionName] !== false
+    );
+  });
+  if (enabledAutoConfigs.length > 0) {
+    console.log("Auto-configured plugins:");
   }
-  if (packageExists.vitest || options?.vitest || process.env.INSPECTOR) {
-    configs.push(vitest());
+  for (const autoConfig of enabledAutoConfigs) {
+    console.log(`- ${autoConfig.name}`);
+    const autoConfigOptions = options?.[autoConfig.optionName];
+    configs.push(autoConfig.config(autoConfigOptions));
   }
   const merged = configs.flat();
   return merged;
 }
+var src_default = config;
 export {
-  factory as default
+  src_default as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@will-stone/eslint-config",
-  "version": "11.0.2",
+  "version": "11.0.3",
   "description": "Will Stone's ESLint config",
   "keywords": [
     "eslint-config"
@@ -26,12 +26,13 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format esm --clean --dts",
-    "dev": "tsup src/index.ts --format esm --watch & INSPECTOR=true config-inspector",
+    "dev": "tsup src/index.ts --format esm --watch & config-inspector --config ./eslint-config-for-inspector.js",
     "lint": "npm run stub && eslint .",
     "prepare": "husky",
     "prepublishOnly": "npm run build",
     "release": "release-it",
     "stub": "tsup src/index.ts --format esm",
+    "test": "vitest",
     "typecheck": "tsc --noEmit"
   },
   "lint-staged": {
@@ -45,8 +46,8 @@
   "prettier": "@will-stone/prettier-config",
   "dependencies": {
     "@eslint/compat": "^1.1.1",
-    "@typescript-eslint/eslint-plugin": "^8.0.1",
-    "@typescript-eslint/parser": "^8.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.1.0",
+    "@typescript-eslint/parser": "^8.1.0",
     "astro-eslint-parser": "^1.0.2",
     "confusing-browser-globals": "^1.0.11",
     "eslint-config-flat-gitignore": "^0.1.8",
@@ -72,14 +73,16 @@
     "@types/confusing-browser-globals": "^1.0.3",
     "@types/eslint": "^9.6.0",
     "@types/node": "^22.2.0",
-    "@typescript-eslint/utils": "^8.0.1",
+    "@typescript-eslint/utils": "^8.1.0",
     "@will-stone/prettier-config": "^8.0.1",
     "husky": "^9.1.4",
     "lint-staged": "^15.2.8",
+    "memfs": "^4.11.1",
     "prettier": "^3.3.3",
     "release-it": "^17.6.0",
     "tsup": "^8.2.4",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5"
   },
   "peerDependencies": {
     "eslint": ">=9.9.0"