@luxass/eslint-config 4.3.5 → 4.3.7

package/README.md

@@ -5,9 +5,9 @@
 
 ## ✨ Features
 
-- Based on [Antfu's ESLint Config](https://github.com/antfu/eslint-config)
+- Based on [Antfu's ESLint Config](https://github.com/antfu/eslint-config) with some modifications
 - Auto fix for formatting (aimed to be used standalone **without** Prettier)
-- Designed to work with TypeScript, JSX, Vue & Astro out-of-box
+- Designed to work with TypeScript, JSX, Vue out-of-box
 - Lints also for json, yaml, toml, markdown
 - Sorted imports, dangling commas
 - Reasonable defaults, best practices, only one-line of config
@@ -15,44 +15,39 @@
 - [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
 - Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
 - Respects `.gitignore` by default
+- Optional [React](#react), [Svelte](#svelte), [UnoCSS](#unocss), [Astro](#astro) support
 - Optional [formatters](#formatters) support for CSS, HTML, etc.
 
-## 📦 Install
+## Usage
 
-```bash copy
+```bash
 npm install -D eslint @luxass/eslint-config
 ```
 
-## 🚀 Usage
-
-With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+And create a `eslint.config.mjs` in your project root:
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import luxass from '@luxass/eslint-config'
 
 export default luxass()
 ```
 
-With CJS:
-
-```js
-// eslint.config.js
-const luxass = require('@luxass/eslint-config')
-
-module.exports = luxass()
-```
-
+<details>
+<summary>
 Combined with legacy config:
+</summary>
+
+If you still use some configs from the legacy eslintrc format, you can use the [`@eslint/eslintrc`](https://www.npmjs.com/package/@eslint/eslintrc) package to convert them to the flat config.
 
 ```js
-// eslint.config.js
-const luxass = require('@luxass/eslint-config')
-const { FlatCompat } = require('@eslint/eslintrc')
+// eslint.config.mjs
+import luxass from '@luxass/eslint-config'
+import { FlatCompat } from '@eslint/eslintrc'
 
 const compat = new FlatCompat()
 
-module.exports = luxass(
+export default luxass(
   {
     ignores: [],
   },
@@ -71,7 +66,22 @@ module.exports = luxass(
 
 > Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
 
-## Setup for Visual Studio Code
+</details>
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+## Setup for Visual Studio Code (with auto-fix)
 
 Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and add the following to your `.vscode/settings.json`:
 
@@ -118,14 +128,17 @@ Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=d
     "markdown",
     "json",
     "jsonc",
-    "yaml"
+    "yaml",
+    "toml",
+    "gql",
+    "graphql"
   ]
 }
 ```
 
 ## Customization
 
-Normally you would only need to import the `luxass` preset:
+Normally you would only need to import the config and export it:
 
 ```js
 // eslint.config.js
@@ -134,46 +147,67 @@ import luxass from '@luxass/eslint-config'
 export default luxass()
 ```
 
-you can also configure each `config` individually:
+And that's it! Or you can configure each integration individually, for example:
 
 ```js
 // eslint.config.js
 import luxass from '@luxass/eslint-config'
 
 export default luxass({
-  stylistic: true,
+  // Enable stylistic formatting rules
+  // stylistic: true,
+
+  // Or customize the stylistic rules
+  stylistic: {
+    indent: 2, // 4, or 'tab'
+    quotes: 'single', // or 'double'
+  },
+
+  // TypeScript and Vue are auto-detected, you can also explicitly enable them:
   typescript: true,
   vue: true,
-  react: false,
-  astro: true,
-  unocss: true,
 
-  // `.eslintignore` is no longer supported in Flat config, use `ignores` instead.
+  // Disable jsonc and yaml support
+  jsonc: false,
+  yaml: false,
+
+  // `.eslintignore` is no longer supported in Flat config, use `ignores` instead
   ignores: [
-    '**/fixtures'
+    '**/fixtures',
+    // ...globs
   ]
 })
 ```
 
-The `luxass` function accepts an arbitrary number of `flat configs` overrides:
+The `luxass` factory function also accepts any number of arbitrary custom config overrides:
 
 ```js
 // eslint.config.js
 import luxass from '@luxass/eslint-config'
 
-export default luxass({
-  // configuration points for my config
-}, {
-  rules: {}
-}, {
-  rules: {}
-})
+export default luxass(
+  {
+    // Configures for luxass's config
+  },
+
+  // From the second arguments they are ESLint Flat Configs
+  // you can have multiple configs
+  {
+    files: ['**/*.ts'],
+    rules: {},
+  },
+  {
+    rules: {},
+  },
+)
 ```
 
+Going more advanced, you can also import fine-grained configs and compose them as you wish:
+
 <details>
 <summary>Advanced Example</summary>
 
-We don't recommend using this style in general usages, as there are shared options between configs and might need extra care to make them consistent.
+We wouldn't recommend using this style in general unless you know exactly what they are doing, as there are shared options between configs and might need extra care to make them consistent.
 
 ```js
 // eslint.config.js
@@ -240,6 +274,17 @@ When you want to override rules, or disable them inline, you need to update to t
 type foo = { bar: 2 }
 ```
 
+> [!NOTE]
+> About plugin renaming - it is actually rather a dangrous move that might leading to potential naming collisions, pointed out [here](https://github.com/eslint/eslint/discussions/17766) and [here](https://github.com/prettier/eslint-config-prettier#eslintconfigjs-flat-config-plugin-caveat). As this config also very **personal** and **opinionated**, I ambitiously position this config as the only **"top-level"** config per project, that might pivots the taste of how rules are named.
+>
+> This config cares more about the user-facings DX, and try to ease out the implementation details. For example, users could keep using the semantic `import/order` without ever knowing the underlying plugin has migrated twice to `eslint-plugin-i` and then to `eslint-plugin-import-x`. User are also not forced to migrate to the implicit `i/order` halfway only because we swapped the implementation to a fork.
+>
+> That said, it's probably still not a good idea. You might not want to doing this if you are maintaining your own eslint config.
+>
+> Feel free to open issues if you want to combine this config with some other config presets but faced naming collisions. I am happy to figure out a way to make them work. But at this moment I have no plan to revert the renaming.
+
+Since v4.3.0, this preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly.
+
 ### Rules Overrides
 
 Certain rules would only be enabled in specific files, for example, `ts/*` rules would only be enabled in `.ts` files and `vue/*` rules would only be enabled in `.vue` files. If you want to override the rules, you need to specify the file extension:
@@ -249,7 +294,10 @@ Certain rules would only be enabled in specific files, for example, `ts/*` rules
 import luxass from '@luxass/eslint-config'
 
 export default luxass(
-  { vue: true, typescript: true },
+  {
+    vue: true,
+    typescript: true
+  },
   {
     // Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
     files: ['**/*.vue'],
@@ -266,35 +314,66 @@ export default luxass(
 )
 ```
 
-We also provided a `overrides` options to make it easier:
+We also provided a `overrides` options in each integration to make it easier:
 
 ```js
 // eslint.config.js
 import luxass from '@luxass/eslint-config'
 
 export default luxass({
-  overrides: {
-    vue: {
+  vue: {
+    overrides: {
       'vue/operator-linebreak': ['error', 'before'],
     },
-    typescript: {
+  },
+  typescript: {
+    overrides: {
       'ts/consistent-type-definitions': ['error', 'interface'],
     },
-    yaml: {},
-    // ...
-  }
+  },
+  yaml: {
+    overrides: {
+      // ...
+    },
+  },
 })
 ```
 
+### Pipeline
+
+Since v4.3.0, the factory function `luxass()` returns a [pipeline object from `eslint-flat-config-utils`](https://github.com/antfu/eslint-flat-config-utils#pipe) where you can chain the methods to compose the config even more flexibly.
+
+```js
+// eslint.config.js
+import luxass from '@luxass/eslint-config'
+
+export default luxass()
+  .prepend(
+    // some configs before the main config
+  )
+  // overrides any named configs
+  .override(
+    'luxass/imports',
+    {
+      rules: {
+        'import/order': ['error', { 'newlines-between': 'always' }],
+      }
+    }
+  )
+  // rename plugin prefixes
+  .renamePlugins({
+    'old-prefix': 'new-prefix',
+    // ...
+  })
+// ...
+```
+
 ### Optional Configs
 
 We provide some optional configs for specific use cases, that we don't include their dependencies by default.
 
 #### Formatters
 
-> [!WARNING]
-> Experimental feature, changes might not follow semver.
-
 Use external formatters to format files that ESLint cannot handle yet (`.css`, `.html`, etc). Powered by [`eslint-plugin-format`](https://github.com/antfu/eslint-plugin-format).
 
 ```js
@@ -313,11 +392,6 @@ export default luxass({
      * By default uses Prettier
      */
     html: true,
-    /**
-     * Format TOML files
-     * Currently only supports dprint
-     */
-    toml: 'dprint',
     /**
      * Format Markdown files
      * Supports Prettier and dprint
@@ -336,7 +410,7 @@ npm i -D eslint-plugin-format
 
 #### React
 
-To enable React support, need to explicitly turn it on:
+To enable React support, you need to explicitly turn it on:
 
 ```js
 // eslint.config.js
@@ -371,12 +445,31 @@ export default luxass({
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
 
 ```bash
-npm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh @next/eslint-plugin-next
+npm i -D eslint-plugin-react eslint-plugin-react-hooks @next/eslint-plugin-next
+```
+
+#### Astro
+
+To enable astro support, you need to explicitly turn it on:
+
+```js
+// eslint.config.js
+import luxass from '@luxass/eslint-config'
+
+export default luxass({
+  astro: true,
+})
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-astro
 ```
 
 #### UnoCSS
 
-To enable UnoCSS support, need to explicitly turn it on:
+To enable UnoCSS support, you need to explicitly turn it on:
 
 ```js
 // eslint.config.js
@@ -431,6 +524,55 @@ export default luxass({
 })
 ```
 
+### Editor Specific Disables
+
+Some rules are disabled when inside ESLint IDE integrations, namely [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports) [`test/no-focused-tests`](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md)
+
+This is to prevent unused imports from getting removed by the IDE during refactoring to get a better developer experience. Those rules will be applied when you run ESLint in the terminal or [Lint Staged](#lint-staged). If you don't want this behavior, you can disable them:
+
+```js
+// eslint.config.js
+import luxass from '@luxass/eslint-config'
+
+export default luxass({
+  editor: false
+})
+```
+
+### Lint Staged
+
+If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+
+```json
+{
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}
+```
+
+and then
+
+```bash
+npm i -D lint-staged simple-git-hooks
+
+// to active the hooks
+npx simple-git-hooks
+```
+
+## View what rules are enabled
+
+[Antfu](https://github.com/antfu) built a visual tool to help you view what rules are enabled in your project and apply them to what files, [@eslint/config-inspector](https://github.com/eslint/config-inspector)
+
+Go to your project root that contains `eslint.config.js` and run:
+
+```bash
+npx @eslint/config-inspector
+```
+
 ## Versioning Policy
 
 This project follows [Semantic Versioning](https://semver.org/) for releases. However, since this is just a config and involves opinions and many moving parts, we don't treat rules changes as breaking changes.

package/dist/index.cjs

@@ -1673,13 +1673,13 @@ async function unocss(options = {}) {
   return [
     {
       name: "luxass/unocss/setup",
-      files,
       plugins: {
         unocss: pluginUnoCSS
       }
     },
     {
       name: "luxass/unocss/rules",
+      files,
       rules: {
         "unocss/order": "warn",
         ...attributify ? {
@@ -1756,8 +1756,7 @@ async function nextjs(options = {}) {
       name: "luxass/nextjs/default-export-override",
       files: GLOB_NEXTJS_ROUTES,
       rules: {
-        "import/prefer-default-export": "error",
-        "react-refresh/only-export-components": "off"
+        "import/prefer-default-export": "error"
       }
     },
     {
@@ -1767,11 +1766,7 @@ async function nextjs(options = {}) {
         "@next/next/no-img-element": "off",
         "react/no-unknown-property": ["error", {
           ignore: ["tw"]
-        }],
-        "react-refresh/only-export-components": [
-          "warn",
-          { allowConstantExport: true }
-        ]
+        }]
       }
     }
   ];
@@ -1784,13 +1779,14 @@ async function react(options = {}) {
     a11y = false,
     files = [GLOB_JSX, GLOB_TSX],
     overrides = {},
+    refresh = true,
     typescript: typescript2 = true
   } = options;
   await ensure([
     "eslint-plugin-react",
     "eslint-plugin-react-hooks",
-    "eslint-plugin-react-refresh",
-    ...options.a11y ? ["eslint-plugin-jsx-a11y"] : []
+    ...refresh ? ["eslint-plugin-react-refresh"] : [],
+    ...a11y ? ["eslint-plugin-jsx-a11y"] : []
   ]);
   const [
     pluginReact,
@@ -1800,7 +1796,7 @@ async function react(options = {}) {
   ] = await Promise.all([
     interop(import("eslint-plugin-react")),
     interop(import("eslint-plugin-react-hooks")),
-    interop(import("eslint-plugin-react-refresh")),
+    ...refresh ? [interop(import("eslint-plugin-react-refresh"))] : [],
     ...a11y ? [interop(import("eslint-plugin-jsx-a11y"))] : []
   ]);
   const isAllowConstantExport = (0, import_local_pkg2.isPackageExists)("vite");
@@ -1810,7 +1806,7 @@ async function react(options = {}) {
       plugins: {
         "react": pluginReact,
         "react-hooks": pluginReactHooks,
-        "react-refresh": pluginReactRefresh,
+        ...refresh ? { "react-refresh": pluginReactRefresh } : {},
         ...a11y ? { "jsx-a11y": pluginA11y } : {}
       }
     },
@@ -2039,7 +2035,9 @@ async function react(options = {}) {
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
         // react refresh
-        "react-refresh/only-export-components": ["warn", { allowConstantExport: isAllowConstantExport }],
+        ...refresh ? {
+          "react-refresh/only-export-components": ["warn", { allowConstantExport: isAllowConstantExport }]
+        } : {},
         ...typescript2 ? {
           "react/jsx-no-undef": "off",
           "react/prop-type": "off"
@@ -2174,7 +2172,7 @@ async function tailwindcss(options = {}) {
         }
       },
       plugins: {
-        tailwind: pluginTailwindCSS
+        tailwindcss: pluginTailwindCSS
       }
     },
     {
@@ -2182,19 +2180,19 @@ async function tailwindcss(options = {}) {
       files,
       rules: {
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/classnames-order.md
-        "tailwind/classnames-order": "warn",
+        "tailwindcss/classnames-order": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/enforces-negative-arbitrary-values.md
-        "tailwind/enforces-negative-arbitrary-values": "warn",
+        "tailwindcss/enforces-negative-arbitrary-values": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/enforces-shorthand.md
-        "tailwind/enforces-shorthand": "warn",
+        "tailwindcss/enforces-shorthand": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/migration-from-tailwind-2.md
-        "tailwind/migration-from-tailwind-2": "warn",
+        "tailwindcss/migration-from-tailwind-2": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/no-arbitrary-value.md
-        "tailwind/no-arbitrary-value": "off",
+        "tailwindcss/no-arbitrary-value": "off",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/no-contradicting-classname.md
-        "tailwind/no-contradicting-classname": "error",
+        "tailwindcss/no-contradicting-classname": "error",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/no-custom-classname.md
-        "tailwind/no-custom-classname": "warn",
+        "tailwindcss/no-custom-classname": "warn",
         ...overrides
       }
     }
@@ -2617,8 +2615,10 @@ function luxass(options = {}, ...userConfigs) {
   }
   if (enableReact || enableNextJS) {
     configs.push(react({
+      ...resolveSubOptions(options, "react"),
       overrides: getOverrides(options, "react"),
-      typescript: !!enableTypeScript
+      typescript: !!enableTypeScript,
+      refresh: !enableNextJS
     }));
   }
   if (enableNextJS) {

package/dist/index.d.cts

@@ -3932,42 +3932,42 @@ interface RuleOptions {
    * Enforce a consistent and logical order of the Tailwind CSS classnames
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/classnames-order.md
    */
-  'tailwind/classnames-order'?: Linter.RuleEntry<TailwindClassnamesOrder>
+  'tailwindcss/classnames-order'?: Linter.RuleEntry<TailwindcssClassnamesOrder>
   /**
    * Warns about dash prefixed classnames using arbitrary values
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/enforces-negative-arbitrary-values.md
    */
-  'tailwind/enforces-negative-arbitrary-values'?: Linter.RuleEntry<TailwindEnforcesNegativeArbitraryValues>
+  'tailwindcss/enforces-negative-arbitrary-values'?: Linter.RuleEntry<TailwindcssEnforcesNegativeArbitraryValues>
   /**
    * Enforces the usage of shorthand Tailwind CSS classnames
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/enforces-shorthand.md
    */
-  'tailwind/enforces-shorthand'?: Linter.RuleEntry<TailwindEnforcesShorthand>
+  'tailwindcss/enforces-shorthand'?: Linter.RuleEntry<TailwindcssEnforcesShorthand>
   /**
    * Detect obsolete classnames when upgrading to Tailwind CSS v3
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/migration-from-tailwind-2.md
    */
-  'tailwind/migration-from-tailwind-2'?: Linter.RuleEntry<TailwindMigrationFromTailwind2>
+  'tailwindcss/migration-from-tailwind-2'?: Linter.RuleEntry<TailwindcssMigrationFromTailwind2>
   /**
    * Forbid using arbitrary values in classnames
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-arbitrary-value.md
    */
-  'tailwind/no-arbitrary-value'?: Linter.RuleEntry<TailwindNoArbitraryValue>
+  'tailwindcss/no-arbitrary-value'?: Linter.RuleEntry<TailwindcssNoArbitraryValue>
   /**
    * Avoid contradicting Tailwind CSS classnames (e.g. "w-3 w-5")
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-contradicting-classname.md
    */
-  'tailwind/no-contradicting-classname'?: Linter.RuleEntry<TailwindNoContradictingClassname>
+  'tailwindcss/no-contradicting-classname'?: Linter.RuleEntry<TailwindcssNoContradictingClassname>
   /**
    * Detect classnames which do not belong to Tailwind CSS
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-custom-classname.md
    */
-  'tailwind/no-custom-classname'?: Linter.RuleEntry<TailwindNoCustomClassname>
+  'tailwindcss/no-custom-classname'?: Linter.RuleEntry<TailwindcssNoCustomClassname>
   /**
    * Forbid using arbitrary values in classnames when an equivalent preset exists
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md
    */
-  'tailwind/no-unnecessary-arbitrary-value'?: Linter.RuleEntry<TailwindNoUnnecessaryArbitraryValue>
+  'tailwindcss/no-unnecessary-arbitrary-value'?: Linter.RuleEntry<TailwindcssNoUnnecessaryArbitraryValue>
   /**
    * Require or disallow spacing around embedded expressions of template strings
    * @see https://eslint.org/docs/latest/rules/template-curly-spacing
@@ -11253,8 +11253,8 @@ type SwitchColonSpacing = []|[{
   before?: boolean
   after?: boolean
 }]
-// ----- tailwind/classnames-order -----
-type TailwindClassnamesOrder = []|[{
+// ----- tailwindcss/classnames-order -----
+type TailwindcssClassnamesOrder = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11264,8 +11264,8 @@ type TailwindClassnamesOrder = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/enforces-negative-arbitrary-values -----
-type TailwindEnforcesNegativeArbitraryValues = []|[{
+// ----- tailwindcss/enforces-negative-arbitrary-values -----
+type TailwindcssEnforcesNegativeArbitraryValues = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11274,8 +11274,8 @@ type TailwindEnforcesNegativeArbitraryValues = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/enforces-shorthand -----
-type TailwindEnforcesShorthand = []|[{
+// ----- tailwindcss/enforces-shorthand -----
+type TailwindcssEnforcesShorthand = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11284,8 +11284,8 @@ type TailwindEnforcesShorthand = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/migration-from-tailwind-2 -----
-type TailwindMigrationFromTailwind2 = []|[{
+// ----- tailwindcss/migration-from-tailwind-2 -----
+type TailwindcssMigrationFromTailwind2 = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11294,8 +11294,8 @@ type TailwindMigrationFromTailwind2 = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-arbitrary-value -----
-type TailwindNoArbitraryValue = []|[{
+// ----- tailwindcss/no-arbitrary-value -----
+type TailwindcssNoArbitraryValue = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11304,8 +11304,8 @@ type TailwindNoArbitraryValue = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-contradicting-classname -----
-type TailwindNoContradictingClassname = []|[{
+// ----- tailwindcss/no-contradicting-classname -----
+type TailwindcssNoContradictingClassname = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11314,8 +11314,8 @@ type TailwindNoContradictingClassname = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-custom-classname -----
-type TailwindNoCustomClassname = []|[{
+// ----- tailwindcss/no-custom-classname -----
+type TailwindcssNoCustomClassname = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11327,8 +11327,8 @@ type TailwindNoCustomClassname = []|[{
   whitelist?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-unnecessary-arbitrary-value -----
-type TailwindNoUnnecessaryArbitraryValue = []|[{
+// ----- tailwindcss/no-unnecessary-arbitrary-value -----
+type TailwindcssNoUnnecessaryArbitraryValue = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -14946,6 +14946,15 @@ interface ReactOptions {
      * @default false
      */
     a11y?: boolean;
+    /**
+     * Enable React Refresh support.
+     *
+     * NOTE:
+     * If you are using NextJS, you should disable this option.
+     *
+     * @default true
+     */
+    refresh?: boolean;
     /**
      * Glob patterns for JSX & TSX files.
      *

package/dist/index.d.ts

@@ -3932,42 +3932,42 @@ interface RuleOptions {
    * Enforce a consistent and logical order of the Tailwind CSS classnames
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/classnames-order.md
    */
-  'tailwind/classnames-order'?: Linter.RuleEntry<TailwindClassnamesOrder>
+  'tailwindcss/classnames-order'?: Linter.RuleEntry<TailwindcssClassnamesOrder>
   /**
    * Warns about dash prefixed classnames using arbitrary values
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/enforces-negative-arbitrary-values.md
    */
-  'tailwind/enforces-negative-arbitrary-values'?: Linter.RuleEntry<TailwindEnforcesNegativeArbitraryValues>
+  'tailwindcss/enforces-negative-arbitrary-values'?: Linter.RuleEntry<TailwindcssEnforcesNegativeArbitraryValues>
   /**
    * Enforces the usage of shorthand Tailwind CSS classnames
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/enforces-shorthand.md
    */
-  'tailwind/enforces-shorthand'?: Linter.RuleEntry<TailwindEnforcesShorthand>
+  'tailwindcss/enforces-shorthand'?: Linter.RuleEntry<TailwindcssEnforcesShorthand>
   /**
    * Detect obsolete classnames when upgrading to Tailwind CSS v3
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/migration-from-tailwind-2.md
    */
-  'tailwind/migration-from-tailwind-2'?: Linter.RuleEntry<TailwindMigrationFromTailwind2>
+  'tailwindcss/migration-from-tailwind-2'?: Linter.RuleEntry<TailwindcssMigrationFromTailwind2>
   /**
    * Forbid using arbitrary values in classnames
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-arbitrary-value.md
    */
-  'tailwind/no-arbitrary-value'?: Linter.RuleEntry<TailwindNoArbitraryValue>
+  'tailwindcss/no-arbitrary-value'?: Linter.RuleEntry<TailwindcssNoArbitraryValue>
   /**
    * Avoid contradicting Tailwind CSS classnames (e.g. "w-3 w-5")
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-contradicting-classname.md
    */
-  'tailwind/no-contradicting-classname'?: Linter.RuleEntry<TailwindNoContradictingClassname>
+  'tailwindcss/no-contradicting-classname'?: Linter.RuleEntry<TailwindcssNoContradictingClassname>
   /**
    * Detect classnames which do not belong to Tailwind CSS
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-custom-classname.md
    */
-  'tailwind/no-custom-classname'?: Linter.RuleEntry<TailwindNoCustomClassname>
+  'tailwindcss/no-custom-classname'?: Linter.RuleEntry<TailwindcssNoCustomClassname>
   /**
    * Forbid using arbitrary values in classnames when an equivalent preset exists
    * @see https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md
    */
-  'tailwind/no-unnecessary-arbitrary-value'?: Linter.RuleEntry<TailwindNoUnnecessaryArbitraryValue>
+  'tailwindcss/no-unnecessary-arbitrary-value'?: Linter.RuleEntry<TailwindcssNoUnnecessaryArbitraryValue>
   /**
    * Require or disallow spacing around embedded expressions of template strings
    * @see https://eslint.org/docs/latest/rules/template-curly-spacing
@@ -11253,8 +11253,8 @@ type SwitchColonSpacing = []|[{
   before?: boolean
   after?: boolean
 }]
-// ----- tailwind/classnames-order -----
-type TailwindClassnamesOrder = []|[{
+// ----- tailwindcss/classnames-order -----
+type TailwindcssClassnamesOrder = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11264,8 +11264,8 @@ type TailwindClassnamesOrder = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/enforces-negative-arbitrary-values -----
-type TailwindEnforcesNegativeArbitraryValues = []|[{
+// ----- tailwindcss/enforces-negative-arbitrary-values -----
+type TailwindcssEnforcesNegativeArbitraryValues = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11274,8 +11274,8 @@ type TailwindEnforcesNegativeArbitraryValues = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/enforces-shorthand -----
-type TailwindEnforcesShorthand = []|[{
+// ----- tailwindcss/enforces-shorthand -----
+type TailwindcssEnforcesShorthand = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11284,8 +11284,8 @@ type TailwindEnforcesShorthand = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/migration-from-tailwind-2 -----
-type TailwindMigrationFromTailwind2 = []|[{
+// ----- tailwindcss/migration-from-tailwind-2 -----
+type TailwindcssMigrationFromTailwind2 = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11294,8 +11294,8 @@ type TailwindMigrationFromTailwind2 = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-arbitrary-value -----
-type TailwindNoArbitraryValue = []|[{
+// ----- tailwindcss/no-arbitrary-value -----
+type TailwindcssNoArbitraryValue = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11304,8 +11304,8 @@ type TailwindNoArbitraryValue = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-contradicting-classname -----
-type TailwindNoContradictingClassname = []|[{
+// ----- tailwindcss/no-contradicting-classname -----
+type TailwindcssNoContradictingClassname = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11314,8 +11314,8 @@ type TailwindNoContradictingClassname = []|[{
   tags?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-custom-classname -----
-type TailwindNoCustomClassname = []|[{
+// ----- tailwindcss/no-custom-classname -----
+type TailwindcssNoCustomClassname = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -11327,8 +11327,8 @@ type TailwindNoCustomClassname = []|[{
   whitelist?: string[]
   [k: string]: unknown | undefined
 }]
-// ----- tailwind/no-unnecessary-arbitrary-value -----
-type TailwindNoUnnecessaryArbitraryValue = []|[{
+// ----- tailwindcss/no-unnecessary-arbitrary-value -----
+type TailwindcssNoUnnecessaryArbitraryValue = []|[{
   callees?: string[]
   ignoredKeys?: string[]
   config?: (string | {
@@ -14946,6 +14946,15 @@ interface ReactOptions {
      * @default false
      */
     a11y?: boolean;
+    /**
+     * Enable React Refresh support.
+     *
+     * NOTE:
+     * If you are using NextJS, you should disable this option.
+     *
+     * @default true
+     */
+    refresh?: boolean;
     /**
      * Glob patterns for JSX & TSX files.
      *

package/dist/index.js

@@ -1578,13 +1578,13 @@ async function unocss(options = {}) {
   return [
     {
       name: "luxass/unocss/setup",
-      files,
       plugins: {
         unocss: pluginUnoCSS
       }
     },
     {
       name: "luxass/unocss/rules",
+      files,
       rules: {
         "unocss/order": "warn",
         ...attributify ? {
@@ -1661,8 +1661,7 @@ async function nextjs(options = {}) {
       name: "luxass/nextjs/default-export-override",
       files: GLOB_NEXTJS_ROUTES,
       rules: {
-        "import/prefer-default-export": "error",
-        "react-refresh/only-export-components": "off"
+        "import/prefer-default-export": "error"
       }
     },
     {
@@ -1672,11 +1671,7 @@ async function nextjs(options = {}) {
         "@next/next/no-img-element": "off",
         "react/no-unknown-property": ["error", {
           ignore: ["tw"]
-        }],
-        "react-refresh/only-export-components": [
-          "warn",
-          { allowConstantExport: true }
-        ]
+        }]
       }
     }
   ];
@@ -1689,13 +1684,14 @@ async function react(options = {}) {
     a11y = false,
     files = [GLOB_JSX, GLOB_TSX],
     overrides = {},
+    refresh = true,
     typescript: typescript2 = true
   } = options;
   await ensure([
     "eslint-plugin-react",
     "eslint-plugin-react-hooks",
-    "eslint-plugin-react-refresh",
-    ...options.a11y ? ["eslint-plugin-jsx-a11y"] : []
+    ...refresh ? ["eslint-plugin-react-refresh"] : [],
+    ...a11y ? ["eslint-plugin-jsx-a11y"] : []
   ]);
   const [
     pluginReact,
@@ -1705,7 +1701,7 @@ async function react(options = {}) {
   ] = await Promise.all([
     interop(import("eslint-plugin-react")),
     interop(import("eslint-plugin-react-hooks")),
-    interop(import("eslint-plugin-react-refresh")),
+    ...refresh ? [interop(import("eslint-plugin-react-refresh"))] : [],
     ...a11y ? [interop(import("eslint-plugin-jsx-a11y"))] : []
   ]);
   const isAllowConstantExport = isPackageExists2("vite");
@@ -1715,7 +1711,7 @@ async function react(options = {}) {
       plugins: {
         "react": pluginReact,
         "react-hooks": pluginReactHooks,
-        "react-refresh": pluginReactRefresh,
+        ...refresh ? { "react-refresh": pluginReactRefresh } : {},
         ...a11y ? { "jsx-a11y": pluginA11y } : {}
       }
     },
@@ -1944,7 +1940,9 @@ async function react(options = {}) {
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
         // react refresh
-        "react-refresh/only-export-components": ["warn", { allowConstantExport: isAllowConstantExport }],
+        ...refresh ? {
+          "react-refresh/only-export-components": ["warn", { allowConstantExport: isAllowConstantExport }]
+        } : {},
         ...typescript2 ? {
           "react/jsx-no-undef": "off",
           "react/prop-type": "off"
@@ -2079,7 +2077,7 @@ async function tailwindcss(options = {}) {
         }
       },
       plugins: {
-        tailwind: pluginTailwindCSS
+        tailwindcss: pluginTailwindCSS
       }
     },
     {
@@ -2087,19 +2085,19 @@ async function tailwindcss(options = {}) {
       files,
       rules: {
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/classnames-order.md
-        "tailwind/classnames-order": "warn",
+        "tailwindcss/classnames-order": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/enforces-negative-arbitrary-values.md
-        "tailwind/enforces-negative-arbitrary-values": "warn",
+        "tailwindcss/enforces-negative-arbitrary-values": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/enforces-shorthand.md
-        "tailwind/enforces-shorthand": "warn",
+        "tailwindcss/enforces-shorthand": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/migration-from-tailwind-2.md
-        "tailwind/migration-from-tailwind-2": "warn",
+        "tailwindcss/migration-from-tailwind-2": "warn",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/no-arbitrary-value.md
-        "tailwind/no-arbitrary-value": "off",
+        "tailwindcss/no-arbitrary-value": "off",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/no-contradicting-classname.md
-        "tailwind/no-contradicting-classname": "error",
+        "tailwindcss/no-contradicting-classname": "error",
         // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/docs/rules/no-custom-classname.md
-        "tailwind/no-custom-classname": "warn",
+        "tailwindcss/no-custom-classname": "warn",
         ...overrides
       }
     }
@@ -2522,8 +2520,10 @@ function luxass(options = {}, ...userConfigs) {
   }
   if (enableReact || enableNextJS) {
     configs.push(react({
+      ...resolveSubOptions(options, "react"),
       overrides: getOverrides(options, "react"),
-      typescript: !!enableTypeScript
+      typescript: !!enableTypeScript,
+      refresh: !enableNextJS
     }));
   }
   if (enableNextJS) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luxass/eslint-config",
-  "version": "4.3.5",
+  "version": "4.3.7",
   "description": "ESLint config for @luxass",
   "type": "module",
   "author": {
@@ -136,7 +136,7 @@
     "@stylistic/eslint-plugin-migrate": "^1.7.0",
     "@types/eslint": "^8.56.7",
     "@types/estree": "^1.0.5",
-    "@types/node": "^18.17.19",
+    "@types/node": "^20.12.5",
     "@typescript-eslint/rule-tester": "^7.5.0",
     "@unocss/eslint-plugin": "^0.59.0",
     "astro-eslint-parser": "^0.17.0",