eslint-plugin-better-tailwindcss

ESLint plugin with formatting and linting rules to help you write cleaner, more maintainable Tailwind CSS.

The formatting rules focus on improving readability by automatically breaking up long Tailwind class strings into multiple lines and sorting/grouping them in a logical order. The linting rules enforce best practices and catch potential issues, ensuring that you're writing valid Tailwind CSS.

This plugin supports a wide range of projects, including React, Solid.js, Qwik, Svelte, Vue, Astro, Angular, HTML or plain JavaScript or TypeScript.

Installation

1npm i -D eslint-plugin-better-tailwindcss

Quick start

1. Follow the parsers section below to learn how to configure the plugin for your specific requirements.

2. Configure the plugin to be able to read your tailwind configuration via settings or for each rule separately.

   1// eslint.config.js
   2{
   3  //...
   4  "settings": {
   5    "better-tailwindcss": {
   6      // tailwindcss 4: the path to the entry file of the css based tailwind config (eg: `src/global.css`)
   7      "entryPoint": "src/global.css",
   8      // tailwindcss 3: the path to the tailwind config file (eg: `tailwind.config.js`)
   9      "tailwindConfig": "tailwind.config.js"
   10    }
   11  }
   12}

3. Configure your editor to conveniently auto-fix on save.

Parsers

Depending on the flavor you are using, you may need to install and configure the corresponding parser:

• JSX (React, Solid.js, Qwik)
• TSX (React, Solid.js, Qwik) with TypeScript support
• Svelte
• Vue
• Astro
• Angular
• HTML
• Plain JavaScript
• Plain TypeScript

Rules

The rules are categorized into two types: stylistic and correctness.

Configs

The plugin offers three recommended configurations to help you get started quickly:

• stylistic: Enforces stylistic rules for tailwind classes.
• correctness: Enforces correctness rules for tailwind classes.
• recommended: Enforces both stylistic and correctness rules.

By default:

• stylistic rules are reported as warnings
• correctness rules are reported as errors

You can change the severity by adding a suffix to the config name:

• Use -error to report all rules as errors
• Use -warn to report all rules as warnings

For example, recommended-warn will report every rule as a warning and stylistic-error will report the formatting rules as errors.

The table below lists all available rules, the Tailwind CSS versions they support, and whether they are enabled by default in each recommended configuration:

Stylistic rules

Name	Description	tw3	tw4	recommended	autofix
enforce-consistent-line-wrapping	Enforce consistent line wrapping for tailwind classes.	✔	✔	✔	✔
enforce-consistent-class-order	Enforce a consistent order for tailwind classes.	✔	✔	✔	✔
enforce-consistent-variable-syntax	Enforce consistent variable syntax.	✔	✔		✔
enforce-shorthand-classes	Enforce shorthand class names.	✔	✔		✔
no-duplicate-classes	Remove duplicate classes.	✔	✔	✔	✔
no-unnecessary-whitespace	Disallow unnecessary whitespace in tailwind classes.	✔	✔	✔	✔

Correctness rules

Name	Description	tw3	tw4	recommended	autofix
no-unregistered-classes	Report classes not registered with tailwindcss.	✔	✔	✔
no-conflicting-classes	Report classes that produce conflicting styles.		✔
no-restricted-classes	Disallow restricted classes.	✔	✔		✔

Utilities

This plugin works out of the box with most popular tailwind utilities:

• tailwind merge
• class variance authority
• tailwind variants
• shadcn
• classcat
• class list builder
• clsx
• cnbuilder
• classnames template literals
• obj str

Advanced configuration

If an utility is not supported by default, or you want to customize the configuration, you can define which string literals should be linted for each rule. See the Advanced configuration guide to learn how to override or extend the default settings.

Editor configuration

VSCode

Auto-fix on save

Most rules are intended to automatically fix the tailwind classes. If you have installed the VSCode ESLint plugin, you can configure it to automatically fix the classes on save by adding the following options to your .vscode/settings.json:

1{
2  // enable ESLint to fix tailwind classes on save
3  "editor.codeActionsOnSave": {
4    "source.fixAll.eslint": "explicit"
5  }
6}