eslint-plugin-better-tailwindcss

ESLint/Oxlint 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

``sh
npm i -D eslint-plugin-better-tailwindcss
`

Quick start

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

- React: .jsx · .tsx
- SolidJS: .jsx · .tsx
- Qwik: .jsx · .tsx
- Svelte: .svelte
- Vue: .vue
- Astro: .astro
- Angular: .html, .ts
- HTML: .html
- CSS: .css
- JavaScript: .js
- TypeScript: .ts

$3

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.

If you still use the old .eslintrc configuration format, you can prefix the config names with legacy-.

For example, legacy-recommended or legacy-correctness-warn.

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. | ✔ | ✔ | | ✔ |
| enforce-canonical-classes | Enforce canonical 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-unknown-classes | Report classes not registered with Tailwind CSS. | ✔ | ✔ | ✔ | |
| no-conflicting-classes | Report classes that produce conflicting styles. | | ✔ | ✔ | |
| no-restricted-classes | Disallow restricted classes. | ✔ | ✔ | | ✔ |

$3

This plugin is pre-configured to lint tailwind classes for the most popular utilities:

- tailwind merge: twMerge · twJoin
- class variance authority: cva
- tailwind variants: tv
- shadcn: cn
- classcat: cc
- class list builder: clb
- clsx: clsx
- cnbuilder: cnb
- classnames template literals: ctl
- obj str: objstr

$3

If an utility is not supported by default, or you want to customize the configuration, you can define which callees, attributes, tags and variables should get linted.
See the Advanced configuration guide to learn how to override or extend the default settings.

$3

#### 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:

`jsonc
{
// enable ESLint to fix tailwind classes on save
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
}
}
``