@fabdeh/eslint-config 0.5.0 → 0.6.0

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import { ConfigArray, ConfigWithExtends } from 'typescript-eslint';
 import { StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
 import { TSESLint } from '@typescript-eslint/utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+import { Attributes, Callees, Variables, Tags } from 'eslint-plugin-better-tailwindcss/api/types';
 
 /**
  * Vendor types from Prettier so we don't rely on the dependency.
@@ -313,12 +314,55 @@ interface RegExpOptions {
      */
     level?: 'error' | 'warn';
 }
-interface TailwindcssParserPerGlobOptions {
+/**
+ * Interface for better-tailwindcss specific options.
+ */
+interface TailwindCssOptions {
     /**
      * Provides a specific ESLint parser per glob pattern.
-     * This is only needed if you want to lint tailwindcss without using Angular and TypeScript.
      */
     parsers?: Record<string, TSESLint.FlatConfig.Parser>;
+    /**
+     * Use all better-tailwindcss rules or only recommended ones.
+     *
+     * @default false
+     */
+    enableAllRules?: boolean;
+    /**
+     * The path to the entry file of the CSS-based tailwind config (eg: `src/global.css`). If not specified, the plugin will fall back to the default configuration.
+     * The tailwind config is used to determine the sorting order.
+     */
+    entryPoint?: string;
+    /**
+     * The path to the `tailwind.config.js` file. If not specified, the plugin will try to find it automatically or falls back to the default configuration.
+     * The tailwind config is used to determine the sorting order.
+     */
+    tailwindConfig?: string;
+    /**
+     * The name of the attribute that contains the tailwind classes.
+     *
+     * @default Name for `"class"` and strings Matcher for `"class", "className"`.
+     */
+    attributes?: Attributes;
+    /**
+     * List of function names which arguments should also get linted.
+     *
+     * @default  Matchers for `"cc", "clb", "clsx", "cn", "cnb", "ctl", "cva", "cx", "dcnb", "objstr", "tv", "twJoin", "twMerge"`.
+     */
+    callees?: Callees;
+    /**
+     * List of variable names whose initializer should also get linted.
+     *
+     * @default strings Matcher for `"className", "classNames", "classes", "style", "styles"`.
+     */
+    variables?: Variables;
+    /**
+     * List of template literal tag names whose content should get linted.
+     * When using the `tags` option, it is recommended to use the strings Matcher for your tag names. This will ensure that nested expressions get linted correctly.
+     *
+     * @default None
+     */
+    tags?: Tags;
 }
 /**
  * Options for creating an ESLint configuration.
@@ -394,7 +438,7 @@ interface CreateConfigOptions {
      *
      * @default false
      */
-    tailwindcss?: boolean | (FilesOptions & OverridesOptions) | (OverridesOptions & TailwindcssParserPerGlobOptions);
+    tailwindcss?: boolean | (FilesOptions & OverridesOptions & TailwindCssOptions);
     /**
      * Enable JSONC support.
      *
@@ -624,18 +668,19 @@ declare const STYLISTIC_CONFIG_DEFAULT: StylisticConfig;
 declare function stylistic(options?: StylisticOptions): Promise<ConfigArray>;
 
 /**
- * Generates an ESLint configuration array for Tailwind CSS.
+ * Generates an ESLint configuration array for Tailwind CSS using better-tailwindcss plugin.
  *
  * @param [options] - Optional overrides for the configuration.
  * @returns  A promise that resolves to the ESLint configuration array.
  * @example
  * const config = await tailwindcss({
+ *   enableAllRules: true,
  *   overrides: {
- *     'tailwindcss/classnames-order': 'warn',
+ *     'better-tailwindcss/recommended': 'warn',
  *   },
  * });
  */
-declare function tailwindcss(options?: (FilesOptions & OverridesOptions) | (OverridesOptions & TailwindcssParserPerGlobOptions)): Promise<ConfigArray>;
+declare function tailwindcss(options?: (FilesOptions & OverridesOptions & TailwindCssOptions)): Promise<ConfigArray>;
 
 /**
  * Generates an ESLint configuration for TOML files.
@@ -805,4 +850,4 @@ type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 declare function resolveSubOptions<K extends keyof CreateConfigOptions>(options: CreateConfigOptions, key: K): ResolvedOptions<CreateConfigOptions[K]>;
 
 export { GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, STYLISTIC_CONFIG_DEFAULT, angular, comments, defineConfig, ensurePackages, findNearestPackageJsonName, getTsConfigFileName, getWorkspaceRoot, ignores, imports, interopDefault, isPackageInScope, javascript, jsdoc, jsonc, markdown, ngrx, perfectionist, regexp, resolveSubOptions, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toml, typescript, unicorn, vitest, yaml };
-export type { AngularOptions, Awaitable, CreateConfigOptions, FilesOptions, FormattersOptions, NgrxOperators, NgrxOptions, OverridesOptions, RegExpOptions, ResolvedOptions, StylisticConfig, StylisticOptions, TailwindcssParserPerGlobOptions, TestingOptions, TypeScriptErasableSyntaxOnlyOptions, TypeScriptParserOptions, UnicornOptions };
+export type { AngularOptions, Awaitable, CreateConfigOptions, FilesOptions, FormattersOptions, NgrxOperators, NgrxOptions, OverridesOptions, RegExpOptions, ResolvedOptions, StylisticConfig, StylisticOptions, TailwindCssOptions, TestingOptions, TypeScriptErasableSyntaxOnlyOptions, TypeScriptParserOptions, UnicornOptions };

package/dist/index.mjs

@@ -139,10 +139,11 @@ async function findNearestPackageJsonName(directoryPath = resolve()) {
   }
 }
 function resolveSubOptions(options, key) {
-  if (typeof options[key] === "boolean") {
-    return {};
+  const option = options[key];
+  if (typeof option === "boolean") {
+    throw new TypeError(`Option ${String(key)} should not be boolean.`);
   }
-  return options[key] ?? {};
+  return option ?? {};
 }
 
 async function angular(options = {}) {
@@ -1231,42 +1232,43 @@ async function stylistic(options = {}) {
   });
 }
 
-function isTailwindcssParserPerGlobOptions(options) {
-  return "parsers" in options && options.parsers !== void 0;
-}
 async function tailwindcss(options = {}) {
-  await ensurePackages(["eslint-plugin-tailwindcss"]);
-  const tailwindcssPlugin = await interopDefault(import('eslint-plugin-tailwindcss'));
+  await ensurePackages(["eslint-plugin-better-tailwindcss"]);
+  const betterTailwindcssPlugin = await interopDefault(import('eslint-plugin-better-tailwindcss'));
+  const { files: filesGlob, overrides, enableAllRules, parsers, ...settings } = options;
   let files;
   let parserConfigs;
-  const { overrides = {} } = options;
-  if (isTailwindcssParserPerGlobOptions(options)) {
-    const parsers = options.parsers ?? {};
+  if (parsers) {
     files = { files: [...new Set(Object.keys(parsers))] };
     parserConfigs = Object.entries(parsers).map(([glob, parser], index) => ({
       name: `fabdeh/tailwindcss/parser-${index + 1}`,
-      file: [glob],
+      files: [glob],
       languageOptions: {
         parser
       }
     }));
   } else {
-    files = { files: options.files ?? [GLOB_SRC, GLOB_HTML] };
+    files = { files: filesGlob ?? [GLOB_SRC, GLOB_HTML] };
     parserConfigs = [];
   }
   return tseslint.config(
     ...parserConfigs,
     {
-      name: "fabdeh/tailwindcss/rules",
-      plugins: { tailwindcss: tailwindcssPlugin },
+      name: "@fabdeh/tailwindcss/rules",
       ...files,
+      plugins: {
+        "better-tailwindcss": betterTailwindcssPlugin
+      },
+      settings: {
+        "better-tailwindcss": settings
+      },
       rules: {
-        "tailwindcss/classnames-order": "error",
-        "tailwindcss/enforces-negative-arbitrary-values": "error",
-        "tailwindcss/enforces-shorthand": "error",
-        "tailwindcss/no-contradicting-classname": "error",
-        "tailwindcss/no-unnecessary-arbitrary-value": "error",
-        ...overrides
+        ...betterTailwindcssPlugin.configs.recommended.rules,
+        ...enableAllRules ? {
+          "better-tailwindcss/enforce-consistent-variable-syntax": "warn",
+          "better-tailwindcss/no-conflicting-classes": "error",
+          "better-tailwindcss/no-restricted-classes": "error"
+        } : {}
       }
     }
   );

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@fabdeh/eslint-config",
   "type": "module",
-  "version": "0.5.0",
-  "packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39",
+  "version": "0.6.0",
+  "packageManager": "pnpm@10.12.1+sha512.f0dda8580f0ee9481c5c79a1d927b9164f2c478e90992ad268bbb2465a736984391d6333d2c327913578b2804af33474ca554ba29c04a8b13060a717675ae3ac",
   "description": "My personal eslint config preset",
   "author": {
     "name": "Fabien Dehopré",
@@ -55,22 +55,22 @@
   "peerDependencies": {
     "@prettier/plugin-xml": "^3.4.1",
     "eslint": "^9.21.0",
+    "eslint-plugin-better-tailwindcss": "^3.4.1",
     "eslint-plugin-erasable-syntax-only": "^0.3.0",
     "eslint-plugin-format": "^1.0.1",
-    "eslint-plugin-tailwindcss": "^3.18.0",
     "prettier-plugin-slidev": "^1.0.5"
   },
   "peerDependenciesMeta": {
     "@prettier/plugin-xml": {
       "optional": true
     },
-    "eslint-plugin-erasable-syntax-only": {
+    "eslint-plugin-better-tailwindcss": {
       "optional": true
     },
-    "eslint-plugin-format": {
+    "eslint-plugin-erasable-syntax-only": {
       "optional": true
     },
-    "eslint-plugin-tailwindcss": {
+    "eslint-plugin-format": {
       "optional": true
     },
     "prettier-plugin-slidev": {
@@ -85,22 +85,22 @@
     "@eslint/markdown": "^6.5.0",
     "@ngrx/eslint-plugin": "^19.2.1",
     "@stylistic/eslint-plugin": "^4.4.1",
-    "@typescript-eslint/eslint-plugin": "^8.33.1",
-    "@typescript-eslint/parser": "^8.33.1",
-    "@typescript-eslint/utils": "^8.33.1",
-    "@vitest/eslint-plugin": "^1.2.1",
+    "@typescript-eslint/eslint-plugin": "^8.34.0",
+    "@typescript-eslint/parser": "^8.34.0",
+    "@typescript-eslint/utils": "^8.34.0",
+    "@vitest/eslint-plugin": "^1.2.2",
     "angular-eslint": "^20.0.0",
     "eslint-config-flat-gitignore": "^2.1.0",
     "eslint-flat-config-utils": "^2.1.0",
     "eslint-merge-processors": "^2.0.0",
     "eslint-plugin-import-x": "^4.15.1",
     "eslint-plugin-jest-dom": "^5.5.0",
-    "eslint-plugin-jsdoc": "^50.7.1",
+    "eslint-plugin-jsdoc": "^50.8.0",
     "eslint-plugin-jsonc": "^2.20.1",
     "eslint-plugin-perfectionist": "^4.14.0",
     "eslint-plugin-prefer-arrow-functions": "^3.6.2",
-    "eslint-plugin-regexp": "^2.8.0",
-    "eslint-plugin-testing-library": "^7.4.0",
+    "eslint-plugin-regexp": "^2.9.0",
+    "eslint-plugin-testing-library": "^7.5.2",
     "eslint-plugin-toml": "^0.12.0",
     "eslint-plugin-unicorn": "^59.0.1",
     "eslint-plugin-unused-imports": "^4.1.4",
@@ -109,11 +109,11 @@
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^1.1.1",
     "toml-eslint-parser": "^0.10.0",
-    "typescript-eslint": "^8.33.1",
+    "typescript-eslint": "^8.34.0",
     "yaml-eslint-parser": "^1.3.0"
   },
   "devDependencies": {
-    "@angular/core": "^20.0.2",
+    "@angular/core": "^20.0.3",
     "@commitlint/cli": "^19.8.1",
     "@commitlint/config-conventional": "^19.8.1",
     "@commitlint/cz-commitlint": "^19.8.1",
@@ -126,14 +126,14 @@
     "@testing-library/angular": "^17.4.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.15.30",
+    "@types/node": "^22.15.31",
     "bumpp": "^10.1.1",
     "changelogithub": "^13.15.0",
     "commitizen": "^4.3.1",
     "eslint": "^9.28.0",
+    "eslint-plugin-better-tailwindcss": "^3.4.0",
     "eslint-plugin-erasable-syntax-only": "^0.3.1",
     "eslint-plugin-format": "^1.0.1",
-    "eslint-plugin-tailwindcss": "^3.18.0",
     "execa": "^9.6.0",
     "fast-glob": "^3.3.3",
     "fs-extra": "^11.3.0",
@@ -143,10 +143,10 @@
     "nano-staged": "^0.8.0",
     "prettier-plugin-slidev": "^1.0.5",
     "simple-git-hooks": "^2.13.0",
-    "tailwindcss": "^3.4.17",
+    "tailwindcss": "^4.1.10",
     "typescript": "^5.8.3",
     "unbuild": "^3.5.0",
-    "vitest": "^3.2.2"
+    "vitest": "^3.2.3"
   },
   "pnpm": {
     "overrides": {