@fullstacksjs/eslint-config 12.4.0 → 12.4.2-next.1

package/README.md

@@ -69,7 +69,7 @@ interface Options {
   cypress?: boolean; // controls cypress plugin
   playwright?: boolean // controls playwright plugin
   storybook?: boolean; // controls storybook plugin
-  tailwind?: boolean | { callee?: string[] }; // controls tailwindcss plugin
+  tailwind?: false | TailwindConfig; // controls tailwindcss plugin
   next?: boolean; // controls next plugin
   prettier?: boolean; // controls prettier plugin
   disableExpensiveRules?: boolean; // controls expensive rules
@@ -115,6 +115,34 @@ export default defineConfig(
 )
 ```
 
+## Tailwind
+
+To enable Tailwind CSS in your project, specify the path to your CSS file in the module configuration:
+
+Tailwind 4:
+```typescript
+export default defineConfig({
+  tailwind: { entryPoint: './src/global.css' },
+})
+```
+
+Tailwind 3:
+```typescript
+export default defineConfig({
+  tailwind: { tailwindConfig: './tailwind.config.js' },
+})
+```
+
+## GitIgnore
+
+By default, FullstacksJS checks for a `.gitignore` file at the root of the project. If the file exists, it will be used automatically. You can override this behavior by updating the configuration.
+
+```typescript
+export default defineConfig({
+  gitignore: './packages/acme/.gitignore', // use `false` to disable
+})
+```
+
 ## I'm Getting a Next.js Warning: Plugin Was Not Detected
 
 This configuration includes built-in support for [Next.js](https://nextjs.org). The warning you're seeing from Next.js is misleading—it simply checks whether the plugin is explicitly listed in your package.json.
@@ -178,7 +206,7 @@ export default defineConfig({
 * [eslint-plugin-promise](https://github.com/eslint-community/eslint-plugin-promise)
 * [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)
 * [eslint-plugin-storybook](https://github.com/storybookjs/eslint-plugin-storybook#readme)
-* [eslint-plugin-tailwindcss](https://github.com/francoismassart/eslint-plugin-tailwindcss)
+* [eslint-plugin-better-tailwindcss](https://github.com/schoero/eslint-plugin-better-tailwindcss)
 * [eslint-plugin-vitest](https://www.npmjs.com/package/eslint-plugin-vitest)
 * [typescript-eslint](https://typescript-eslint.io/)
 

package/cjs/index.d.ts

@@ -7,6 +7,13 @@ interface ProjectService {
   maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING: number;
 }
 
+type TailwindConfig = {
+  callees?: string[];
+  variables?: string[];
+  attributes?: string[];
+  tags?: string[];
+} & ({ entryPoint: string; tailwindConfig?: string } | { entryPoint?: string; tailwindConfig: string });
+
 export interface Options extends Linter.Config {
   /**
    * Controls React plugin.
@@ -24,9 +31,10 @@ export interface Options extends Linter.Config {
   next?: boolean;
   /**
    * Controls Tailwind plugin.
-   * @default true - If you have `tailwind` in your dependencies.
+   * @default false
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md
    */
-  tailwind?: boolean | { callees: string[] };
+  tailwind?: false | TailwindConfig;
   /**
    * Controls [Node plugin](https://www.npmjs.com/package/eslint-plugin-n).
    * @default false
@@ -97,10 +105,10 @@ export interface Options extends Linter.Config {
    */
   ignores?: string[];
   /**
-   * .gitignore file path relative to ESLint configuration file.
+   * .gitignore file path relative to ESLint configuration file. Set to `false` to disable.
    * @default './.gitignore'
    */
-  gitignorePath?: string;
+  gitignore?: string | false;
 }
 
 export declare function defineConfig(initOptions?: Options, ...extend: Linter.Config[]): Linter.Config[];

package/cjs/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.defineConfig = defineConfig;
-exports.init = void 0;
 var _deepmerge = _interopRequireDefault(require("deepmerge"));
 var _config = require("eslint/config");
 var _localPkg = require("local-pkg");
@@ -39,7 +38,7 @@ const defaultOptions = {
   disableExpensiveRules: false,
   esm: false,
   ignores: [],
-  gitignorePath: './.gitignore',
+  gitignore: './.gitignore',
   import: {},
   jest: (0, _localPkg.isPackageExists)('jest'),
   next: (0, _localPkg.isPackageExists)('next'),
@@ -51,7 +50,6 @@ const defaultOptions = {
   storybook: (0, _localPkg.isPackageExists)('storybook'),
   strict: false,
   tailwind: false,
-  // ISSUE: https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/325,
   test: testPackages.some(p => (0, _localPkg.isPackageExists)(p)),
   typescript: (0, _localPkg.isPackageExists)('typescript') ? {
     projectService: true
@@ -67,9 +65,6 @@ const defaultOptions = {
  */
 function defineConfig(initOptions = {}, ...extend) {
   const options = (0, _deepmerge.default)(defaultOptions, initOptions);
-  if (options.tailwind === true) {
-    options.tailwind = {};
-  }
   if (options.import === true) {
     options.import = {};
   }
@@ -79,7 +74,7 @@ function defineConfig(initOptions = {}, ...extend) {
     disableExpensiveRules,
     esm: enableEsm,
     ignores: enableIgnores,
-    gitignorePath,
+    gitignore,
     import: enableImport,
     jest: enableJest,
     next: enableNext,
@@ -114,6 +109,3 @@ function defineConfig(initOptions = {}, ...extend) {
   if (extend) Array.prototype.push.apply(rules, extend);
   return (0, _config.defineConfig)(rules);
 }
-
-/** @deprecated Please use `defineConfig` from `@fullstacksjs/eslint-config` instead, this function will be removed in the next major release. */
-const init = exports.init = defineConfig;

package/cjs/modules/base.js

@@ -19,7 +19,7 @@ function base(options = {}) {
       globals: {
         ..._globals.default.browser,
         ..._globals.default.node,
-        ..._globals.default.es2024
+        ..._globals.default.es2025
       },
       parserOptions: {
         ecmaVersion: 'latest',

package/cjs/modules/ignore.js

@@ -4,18 +4,23 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
-var _compat = require("@eslint/compat");
 var _config = require("eslint/config");
-var _nodePath = _interopRequireDefault(require("node:path"));
+var _getGitignorePatterns = require("../utils/getGitignorePatterns.js");
 var _globs = require("../utils/globs.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
  * @param { import('../index.js').Options } options
  * @return { import('eslint').Linter.Config }
  */
 function ignores(options = {}) {
-  const gitignorePath = _nodePath.default.resolve(process.cwd(), options.gitignorePath);
-  const gitignore = (0, _compat.includeIgnoreFile)(gitignorePath);
-  return (0, _config.globalIgnores)([...gitignore.ignores, ..._globs.ignoreGlobs, ...(options.ignores ?? [])], 'ignores');
+  const ignorePatterns = [..._globs.ignoreGlobs, ...(options.ignores ?? [])];
+  const shouldUseGitignore = options.gitignore && options.gitignore.length > 0;
+  if (shouldUseGitignore) {
+    const gitignorePatterns = (0, _getGitignorePatterns.getGitignorePatterns)(options.gitignore);
+    if (gitignorePatterns.length > 0) {
+      ignorePatterns.push(...gitignorePatterns);
+    }
+  }
+  const uniqueIgnorePatterns = [...new Set(ignorePatterns)];
+  return (0, _config.globalIgnores)(uniqueIgnorePatterns, 'ignores');
 }
 module.exports = ignores;

package/cjs/modules/tailwind.js

@@ -9,24 +9,26 @@ Object.defineProperty(exports, "__esModule", {
  * @return { Promise<import('eslint').Linter.Config> }
  */
 async function tailwind(options = {}) {
-  const plugin = await Promise.resolve().then(() => require('eslint-plugin-tailwindcss'));
+  const plugin = await Promise.resolve().then(() => require('eslint-plugin-better-tailwindcss'));
   return {
     plugins: {
-      tailwindcss: plugin.default ?? plugin
+      'better-tailwindcss': plugin.default ?? plugin
     },
     settings: {
-      tailwindcss: {
-        callees: options.callees ?? ['cva', 'classnames', 'classNames', 'class', 'clsx', 'cn', 'cns', 'cx']
+      'better-tailwindcss': {
+        entryPoint: options.tailwind.entryPoint,
+        tailwindConfig: options.tailwind.tailwindConfig
       }
     },
     rules: {
-      'tailwindcss/classnames-order': 'warn',
-      'tailwindcss/enforces-negative-arbitrary-values': 'warn',
-      'tailwindcss/enforces-shorthand': 'warn',
-      'tailwindcss/migration-from-tailwind-2': 'warn',
-      'tailwindcss/no-arbitrary-value': 'off',
-      'tailwindcss/no-custom-classname': 'warn',
-      'tailwindcss/no-contradicting-classname': 'error'
+      'better-tailwindcss/sort-classes': 'warn',
+      'better-tailwindcss/no-duplicate-classes': 'error',
+      'better-tailwindcss/no-conflicting-classes': 'error',
+      'better-tailwindcss/no-unnecessary-whitespace': 'warn',
+      'better-tailwindcss/enforce-consistent-variable-syntax': 'error',
+      'better-tailwindcss/multiline': ['error', {
+        printWidth: 140
+      }]
     }
   };
 }

package/cjs/utils/getGitignorePatterns.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getGitignorePatterns = getGitignorePatterns;
+var _compat = require("@eslint/compat");
+var _nodeFs = _interopRequireDefault(require("node:fs"));
+var _nodePath = _interopRequireDefault(require("node:path"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/* eslint 'no-console': ['warn', { allow: ['warn'] }] */
+
+const warningMessage = '\u001B[38;2;229;229;14mWarning:\u001B[0m';
+const fallbackMessage = 'Falling back to default ignore patterns. You can suppress this warning by setting \u001B[48;5;234m`gitignore: false`\u001B[0m in the config.';
+
+/**
+ * @param {string} gitignorePath relative path to the .gitignore file
+ * @returns {string[]}
+ */
+function getGitignorePatterns(gitignorePath) {
+  const gitignoreAbsolutePath = _nodePath.default.resolve(process.cwd(), gitignorePath);
+  const gitignoreExists = _nodeFs.default.existsSync(gitignoreAbsolutePath); // eslint-disable-line n/no-sync
+  const gitignorePatterns = [];
+  if (!gitignoreExists) {
+    console.warn(warningMessage, `No .gitignore file found at "${gitignoreAbsolutePath}".`, fallbackMessage);
+    return gitignorePatterns;
+  }
+  const ignorePatterns = (0, _compat.includeIgnoreFile)(gitignoreAbsolutePath).ignores ?? [];
+  if (ignorePatterns.length > 0) {
+    gitignorePatterns.push(...ignorePatterns);
+  } else {
+    console.warn(warningMessage, `No patterns found in .gitignore file at "${gitignoreAbsolutePath}".`, fallbackMessage);
+  }
+  return gitignorePatterns;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "12.4.0",
+  "version": "12.4.2-next.1",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -23,7 +23,7 @@
     "postbuild": "./postbuild",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
-    "pre-commit": "npm run test && lint-staged"
+    "pre-commit": "npm run test && lint-staged && npm run spell"
   },
   "main": "./cjs/index.js",
   "module": "./src/index.mjs",
@@ -40,6 +40,7 @@
     "@next/eslint-plugin-next": "15.3.2",
     "@stylistic/eslint-plugin": "4.4.0",
     "deepmerge": "4.3.1",
+    "eslint-plugin-better-tailwindcss": "3.2.1",
     "eslint-plugin-cypress": "4.3.0",
     "eslint-plugin-import-x": "4.13.3",
     "eslint-plugin-jest": "28.11.0",
@@ -52,7 +53,6 @@
     "eslint-plugin-promise": "7.2.1",
     "eslint-plugin-react-hooks": "5.2.0",
     "eslint-plugin-storybook": "0.12.0",
-    "eslint-plugin-tailwindcss": "3.18.0",
     "eslint-plugin-vitest": "0.5.4",
     "globals": "16.2.0",
     "local-pkg": "1.1.1",

package/src/index.d.ts

@@ -7,6 +7,13 @@ interface ProjectService {
   maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING: number;
 }
 
+type TailwindConfig = {
+  callees?: string[];
+  variables?: string[];
+  attributes?: string[];
+  tags?: string[];
+} & ({ entryPoint: string; tailwindConfig?: string } | { entryPoint?: string; tailwindConfig: string });
+
 export interface Options extends Linter.Config {
   /**
    * Controls React plugin.
@@ -24,9 +31,10 @@ export interface Options extends Linter.Config {
   next?: boolean;
   /**
    * Controls Tailwind plugin.
-   * @default true - If you have `tailwind` in your dependencies.
+   * @default false
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md
    */
-  tailwind?: boolean | { callees: string[] };
+  tailwind?: false | TailwindConfig;
   /**
    * Controls [Node plugin](https://www.npmjs.com/package/eslint-plugin-n).
    * @default false
@@ -97,10 +105,10 @@ export interface Options extends Linter.Config {
    */
   ignores?: string[];
   /**
-   * .gitignore file path relative to ESLint configuration file.
+   * .gitignore file path relative to ESLint configuration file. Set to `false` to disable.
    * @default './.gitignore'
    */
-  gitignorePath?: string;
+  gitignore?: string | false;
 }
 
 export declare function defineConfig(initOptions?: Options, ...extend: Linter.Config[]): Linter.Config[];

package/src/index.mjs

@@ -33,7 +33,7 @@ const defaultOptions = {
   disableExpensiveRules: false,
   esm: false,
   ignores: [],
-  gitignorePath: './.gitignore',
+  gitignore: './.gitignore',
   import: {},
   jest: isPackageExists('jest'),
   next: isPackageExists('next'),
@@ -44,7 +44,7 @@ const defaultOptions = {
   react: isPackageExists('react'),
   storybook: isPackageExists('storybook'),
   strict: false,
-  tailwind: false, // ISSUE: https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/325,
+  tailwind: false,
   test: testPackages.some(p => isPackageExists(p)),
   typescript: isPackageExists('typescript') ? { projectService: true } : false,
   vitest: isPackageExists('vitest'),
@@ -59,9 +59,6 @@ const defaultOptions = {
 export function defineConfig(initOptions = {}, ...extend) {
   const options = merge(defaultOptions, initOptions);
 
-  if (options.tailwind === true) {
-    options.tailwind = {};
-  }
   if (options.import === true) {
     options.import = {};
   }
@@ -72,7 +69,7 @@ export function defineConfig(initOptions = {}, ...extend) {
     disableExpensiveRules,
     esm: enableEsm,
     ignores: enableIgnores,
-    gitignorePath,
+    gitignore,
     import: enableImport,
     jest: enableJest,
     next: enableNext,
@@ -111,6 +108,3 @@ export function defineConfig(initOptions = {}, ...extend) {
 
   return eslintConfig(rules);
 }
-
-/** @deprecated Please use `defineConfig` from `@fullstacksjs/eslint-config` instead, this function will be removed in the next major release. */
-export const init = defineConfig;

package/src/modules/base.mjs

@@ -14,7 +14,7 @@ function base(options = {}) {
       globals: {
         ...globals.browser,
         ...globals.node,
-        ...globals.es2024,
+        ...globals.es2025,
       },
       parserOptions: {
         ecmaVersion: 'latest',

package/src/modules/ignore.mjs

@@ -1,7 +1,6 @@
-import { includeIgnoreFile } from '@eslint/compat';
 import { globalIgnores } from 'eslint/config';
-import path from 'node:path';
 
+import { getGitignorePatterns } from '../utils/getGitignorePatterns.mjs';
 import { ignoreGlobs } from '../utils/globs.mjs';
 
 /**
@@ -9,9 +8,19 @@ import { ignoreGlobs } from '../utils/globs.mjs';
  * @return { import('eslint').Linter.Config }
  */
 function ignores(options = {}) {
-  const gitignorePath = path.resolve(process.cwd(), options.gitignorePath);
-  const gitignore = includeIgnoreFile(gitignorePath);
-  return globalIgnores([...gitignore.ignores, ...ignoreGlobs, ...(options.ignores ?? [])], 'ignores');
+  const ignorePatterns = [...ignoreGlobs, ...(options.ignores ?? [])];
+
+  const shouldUseGitignore = options.gitignore && options.gitignore.length > 0;
+  if (shouldUseGitignore) {
+    const gitignorePatterns = getGitignorePatterns(options.gitignore);
+    if (gitignorePatterns.length > 0) {
+      ignorePatterns.push(...gitignorePatterns);
+    }
+  }
+
+  const uniqueIgnorePatterns = [...new Set(ignorePatterns)];
+
+  return globalIgnores(uniqueIgnorePatterns, 'ignores');
 }
 
 export default ignores;

package/src/modules/tailwind.mjs

@@ -3,22 +3,22 @@
  * @return { Promise<import('eslint').Linter.Config> }
  */
 async function tailwind(options = {}) {
-  const plugin = await import('eslint-plugin-tailwindcss');
+  const plugin = await import('eslint-plugin-better-tailwindcss');
   return {
-    plugins: { tailwindcss: plugin.default ?? plugin },
+    plugins: { 'better-tailwindcss': plugin.default ?? plugin },
     settings: {
-      tailwindcss: {
-        callees: options.callees ?? ['cva', 'classnames', 'classNames', 'class', 'clsx', 'cn', 'cns', 'cx'],
+      'better-tailwindcss': {
+        entryPoint: options.tailwind.entryPoint,
+        tailwindConfig: options.tailwind.tailwindConfig,
       },
     },
     rules: {
-      'tailwindcss/classnames-order': 'warn',
-      'tailwindcss/enforces-negative-arbitrary-values': 'warn',
-      'tailwindcss/enforces-shorthand': 'warn',
-      'tailwindcss/migration-from-tailwind-2': 'warn',
-      'tailwindcss/no-arbitrary-value': 'off',
-      'tailwindcss/no-custom-classname': 'warn',
-      'tailwindcss/no-contradicting-classname': 'error',
+      'better-tailwindcss/sort-classes': 'warn',
+      'better-tailwindcss/no-duplicate-classes': 'error',
+      'better-tailwindcss/no-conflicting-classes': 'error',
+      'better-tailwindcss/no-unnecessary-whitespace': 'warn',
+      'better-tailwindcss/enforce-consistent-variable-syntax': 'error',
+      'better-tailwindcss/multiline': ['error', { printWidth: 140 }],
     },
   };
 }

package/src/utils/getGitignorePatterns.mjs

@@ -0,0 +1,35 @@
+/* eslint 'no-console': ['warn', { allow: ['warn'] }] */
+
+import { includeIgnoreFile } from '@eslint/compat';
+import fs from 'node:fs';
+import path from 'node:path';
+
+const warningMessage = '\u001B[38;2;229;229;14mWarning:\u001B[0m';
+const fallbackMessage =
+  'Falling back to default ignore patterns. You can suppress this warning by setting \u001B[48;5;234m`gitignore: false`\u001B[0m in the config.';
+
+/**
+ * @param {string} gitignorePath relative path to the .gitignore file
+ * @returns {string[]}
+ */
+export function getGitignorePatterns(gitignorePath) {
+  const gitignoreAbsolutePath = path.resolve(process.cwd(), gitignorePath);
+  const gitignoreExists = fs.existsSync(gitignoreAbsolutePath); // eslint-disable-line n/no-sync
+  const gitignorePatterns = [];
+
+  if (!gitignoreExists) {
+    console.warn(warningMessage, `No .gitignore file found at "${gitignoreAbsolutePath}".`, fallbackMessage);
+
+    return gitignorePatterns;
+  }
+
+  const ignorePatterns = includeIgnoreFile(gitignoreAbsolutePath).ignores ?? [];
+
+  if (ignorePatterns.length > 0) {
+    gitignorePatterns.push(...ignorePatterns);
+  } else {
+    console.warn(warningMessage, `No patterns found in .gitignore file at "${gitignoreAbsolutePath}".`, fallbackMessage);
+  }
+
+  return gitignorePatterns;
+}