schoero
</picture>
eslint-plugin-better-tailwindcss
</picture>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=32363B&color=ffffff" /><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/npm/v/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=EBEEF2&color=000000" />
</picture>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/issues/schoero/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=32363B&color=ffffff" /><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/github/issues/schoero/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=EBEEF2&color=000000" />
</picture>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/dt/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=32363B&color=ffffff" /><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/npm/dt/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=EBEEF2&color=000000" />
</picture>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/stars/schoero/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=32363B&color=ffffff" /><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/github/stars/schoero/eslint-plugin-better-tailwindcss?style=flat-square&labelColor=EBEEF2&color=000000" />
</picture>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/sponsors/schoero?style=flat-square&labelColor=32363B&color=ffffff" /><source media="(prefers-color-scheme: light)" srcset="hhttps://img.shields.io/github/sponsors/schoero?style=flat-square&labelColor=EBEEF2&color=000000" />
</picture>
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.
</picture>
Buy me a coffee | GitHub Sponsors
Help support this project.
If you or your company benefit from this project, please consider becoming a sponsor or making a one-time donation.
Your contribution will help me to maintain and develop the project.
Installation
npm i -D eslint-plugin-better-tailwindcssQuick start
Follow the parsers section below to learn how to configure the plugin for your specific requirements.
Configure the plugin to be able to read your tailwind configuration via settings or for each rule separately.
// eslint.config.js { //... "settings": { "better-tailwindcss": { // tailwindcss 4: the path to the entry file of the css based tailwind config (eg: `src/global.css`) "entryPoint": "src/global.css", // tailwindcss 3: the path to the tailwind config file (eg: `tailwind.config.js`) "tailwindConfig": "tailwind.config.js" } } }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:
stylisticrules are reported as warningscorrectnessrules are reported as errors
You can change the severity by adding a suffix to the config name:
- Use
-errorto report all rules as errors - Use
-warnto 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-consistent-important-position | Enforce consistent position of the important modifier. | ✔ | ✔ | | ✔ | |
| enforce-shorthand-classes | Enforce shorthand class names. | ✔ | ✔ | | ✔ | |
| no-duplicate-classes | Remove duplicate classes. | ✔ | ✔ | ✔ | ✔ |
| no-deprecated-classes | Remove deprecated 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:
{
// enable ESLint to fix tailwind classes on save
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
}
}