@dauphaihau/eslint-config 0.2.1 → 0.2.3

package/README.md

@@ -2,7 +2,7 @@
 
 - Auto fix for formatting (aimed to be used standalone without Prettier)
 - Opinionated, but very customizable
-- Optional TypeScript support
+- Auto-detects your tech stack (React, TypeScript, Tailwind, etc.)
 - ESLint Flat config, compose easily!
 
 ## Installation
@@ -11,13 +11,28 @@
 npm i -D @dauphaihau/eslint-config
 ```
 
+If your project uses React, install the React ESLint plugins as well:
+
+```bash
+npm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh
+```
+
+If your project uses Tailwind CSS, install the Tailwind ESLint plugin as well:
+
+```bash
+npm i -D eslint-plugin-tailwindcss
+```
+
 And create `eslint.config.mjs` in your project root:
 
 ```js
 // eslint.config.mjs
-import dauphaihau from '@dauphaihau/eslint-config'
+import dauphaihauConfig from '@dauphaihau/eslint-config'
+import { defineConfig } from 'eslint/config'
 
-export default dauphaihau()
+export default defineConfig([
+  ...(await dauphaihauConfig())
+])
 ```
 
 ### Add script for package.json
@@ -36,27 +51,41 @@ For example:
 ## Usage
 
 ### Basic
-Normally you only need to import the dauphaihau preset:
+Normally you only need to import the dauphaihauConfig preset:
 
 ```js
 // eslint.config.js
-import dauphaihau from '@dauphaihau/eslint-config'
+import dauphaihauConfig from '@dauphaihau/eslint-config'
+import { defineConfig } from 'eslint/config'
 
-export default dauphaihau()
+export default defineConfig([
+  ...(await dauphaihauConfig())
+])
 ```
 
 ### Customize
 
+The config auto-detects your tech stack. Pass `false` to explicitly disable rules for a specific stack:
+
 ```js
 // eslint.config.js
-import dauphaihau from '@dauphaihau/eslint-config'
-
-export default dauphaihau({
-  typescript: true,
-})
-
+import dauphaihauConfig from '@dauphaihau/eslint-config'
+import { defineConfig } from 'eslint/config'
+
+export default defineConfig([
+  ...(await dauphaihauConfig({
+    tailwind: false, // disable Tailwind rules
+  })),
+
+  // Your configs and overrides
+  {
+    files: ['**/*.{ts,tsx}'],
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'off',
+    },
+  },
+])
 ```
 ## License
 
 MIT
-

package/dist/index.js

@@ -551,9 +551,11 @@ async function reactConfig(options = {}) {
 }
 
 // src/configs/tailwind.ts
+import fs2 from "fs";
+var tailwindConfigFile = ["tailwind.config.js", "tailwind.config.ts", "tailwind.config.mjs", "tailwind.config.cjs"].find((f) => fs2.existsSync(f));
 async function tailwindConfig(options = {}) {
   const tailwindFiles = strategyManager.getTailwindFiles(options);
-  if (tailwindFiles.length === 0) {
+  if (tailwindFiles.length === 0 || !tailwindConfigFile) {
     return [];
   }
   const { default: tailwind } = await import("eslint-plugin-tailwindcss");
@@ -564,9 +566,8 @@ async function tailwindConfig(options = {}) {
       plugins: { tailwindcss: tailwind },
       settings: {
         tailwindcss: {
-          // Common utility function callees to analyze for class names
+          config: tailwindConfigFile,
           callees: ["classnames", "clsx", "ctl", "cva", "cx", "cn"],
-          // Support tagged template literals: tw`bg-blue-500`
           tags: ["tw"]
         }
       },
@@ -614,24 +615,6 @@ var identifierQualityRules = {
   "id-denylist": ["warn", "foo", "bar", "baz", "tmp", "arr", "obj", "data"]
 };
 var variableNamingSelectors = [
-  // Valid examples: userName, fetchUsers, _internalValue
-  {
-    selector: ["variable", "function"],
-    format: ["camelCase"],
-    leadingUnderscore: "allow"
-    // allows _privateVar
-  },
-  {
-    // Enforce UPPER_CASE for exported constants.
-    // Valid examples: API_BASE_URL, MAX_RETRY_COUNT, DEFAULT_TIMEOUT_MS
-    selector: "variable",
-    modifiers: ["const", "exported"],
-    format: ["UPPER_CASE"],
-    filter: {
-      regex: "^[A-Z0-9_]+$",
-      match: true
-    }
-  },
   // ---------- Boolean naming ----------
   {
     selector: "variable",
@@ -639,6 +622,20 @@ var variableNamingSelectors = [
     format: ["PascalCase", "camelCase"],
     prefix: ["is", "has", "should", "can", "did", "will"],
     filter: { regex: "^(is|has|should|can|did|will)[A-Z]", match: true }
+  },
+  {
+    // Valid examples: apiBaseUrl, DEFAULT_TIMEOUT_MS, _internalValue
+    selector: "variable",
+    modifiers: ["const"],
+    format: ["camelCase", "UPPER_CASE"],
+    leadingUnderscore: "allow"
+  },
+  // Valid examples: userName, fetchUsers, _internalValue
+  {
+    selector: ["variable", "function"],
+    format: ["camelCase"],
+    leadingUnderscore: "allow"
+    // allows _privateVar
   }
 ];
 var baseNamingSelectors = [
@@ -745,7 +742,7 @@ function namingConfig(options = {}) {
             selector: "variable",
             format: ["camelCase", "PascalCase"],
             filter: {
-              regex: "^[A-Z]",
+              regex: "^[A-Z][a-zA-Z0-9]*$",
               match: true
             }
           },
@@ -993,13 +990,13 @@ var ESLintConfigBuilder = class {
 };
 
 // src/index.ts
-import fs2 from "fs";
-var hasTsConfig = fs2.existsSync("tsconfig.json") || fs2.existsSync("tsconfig.base.json");
+import fs3 from "fs";
+var hasTsConfig = fs3.existsSync("tsconfig.json") || fs3.existsSync("tsconfig.base.json");
 var hasReact = () => {
   try {
     const packageJsonPath = "package.json";
-    if (fs2.existsSync(packageJsonPath)) {
-      const packageJson = JSON.parse(fs2.readFileSync(packageJsonPath, "utf-8"));
+    if (fs3.existsSync(packageJsonPath)) {
+      const packageJson = JSON.parse(fs3.readFileSync(packageJsonPath, "utf-8"));
       const deps = {
         ...packageJson.dependencies,
         ...packageJson.devDependencies,
@@ -1014,8 +1011,8 @@ var hasReact = () => {
 var hasTailwind = () => {
   try {
     const packageJsonPath = "package.json";
-    if (fs2.existsSync(packageJsonPath)) {
-      const packageJson = JSON.parse(fs2.readFileSync(packageJsonPath, "utf-8"));
+    if (fs3.existsSync(packageJsonPath)) {
+      const packageJson = JSON.parse(fs3.readFileSync(packageJsonPath, "utf-8"));
       const deps = {
         ...packageJson.dependencies,
         ...packageJson.devDependencies,
@@ -1025,7 +1022,7 @@ var hasTailwind = () => {
     }
   } catch {
   }
-  return fs2.existsSync("tailwind.config.js") || fs2.existsSync("tailwind.config.ts") || fs2.existsSync("tailwind.config.mjs") || fs2.existsSync("tailwind.config.cjs");
+  return fs3.existsSync("tailwind.config.js") || fs3.existsSync("tailwind.config.ts") || fs3.existsSync("tailwind.config.mjs") || fs3.existsSync("tailwind.config.cjs");
 };
 function eslintConfig(options = {}) {
   const finalOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dauphaihau/eslint-config",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,16 +45,19 @@
     "eslint-plugin-tailwindcss": "^3.18.2",
     "jiti": "^2.0.0",
     "tsup": "^8.0.0",
-    "typescript": "^5.4.0"
+    "typescript": "^5.4.0",
+    "vitest": "^3.2.4"
   },
   "scripts": {
     "build": "pnpm exec tsup src/index.ts --dts --format esm --external @eslint/js --external @stylistic/eslint-plugin --external typescript-eslint --external eslint-plugin-check-file --external eslint-plugin-react --external eslint-plugin-react-hooks --external eslint-plugin-react-refresh --external eslint-plugin-tailwindcss",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
+    "test": "vitest run",
     "typecheck": "tsc --noEmit",
     "version:patch": "pnpm build && pnpm version patch",
     "version:minor": "pnpm build && pnpm version minor",
     "version:major": "pnpm build && pnpm version major",
-    "push": "git push --follow-tags"
+    "push:tags": "git push --follow-tags",
+    "ship": "pnpm publish --no-git-checks"
   }
 }