src/content/docs/linter/rules/use-sorted-classes.mdx
import { Tabs, TabItem } from '@astrojs/starlight/components';
<Tabs> <TabItem label="JavaScript (and super languages)" icon="seti:javascript"> :::caution This rule is part of the [nursery](/linter/#nursery) group. This means that it is experimental and the behavior can change at any time. ::: ## Summary - Rule available since: `v1.6.0` - Diagnostic Category: [`lint/nursery/useSortedClasses`](/reference/diagnostics#diagnostic-category) - This rule has an [**unsafe**](/linter/#unsafe-fixes) fix. - The default severity of this rule is [**information**](/reference/diagnostics#information). ## How to configure ```json title="biome.json" { "linter": { "rules": { "nursery": { "useSortedClasses": "error" } } } }## Description
Enforce the sorting of CSS utility classes.
This rule implements the same sorting algorithm as [Tailwind CSS](https://tailwindcss.com/blog/automatic-class-sorting-with-prettier#how-classes-are-sorted), but supports any utility class framework including [UnoCSS](https://unocss.dev/).
It is analogous to [`prettier-plugin-tailwindcss`](https://github.com/tailwindlabs/prettier-plugin-tailwindcss).
:::caution
## Important notes
This rule is a work in progress, and is only partially implemented. Progress is being tracked in the following GitHub issue: https://github.com/biomejs/biome/issues/1274
Currently, utility class sorting is **not part of the formatter**, and is implemented as a linter rule instead, with an automatic fix. The fix is, at this stage, classified as unsafe. This means that **it won't be applied automatically** as part of IDE actions such as "fix on save".
We appreciate any feedback on this rule, and encourage you to try it out and report any issues you find.
**Please read this entire documentation page before reporting an issue.**
Notably, keep in mind that the following features are not supported yet:
- Screen variant sorting (e.g. `md:`, `max-lg:`). Only static, dynamic and arbitrary variants are supported.
- Custom utilitites and variants (such as ones introduced by Tailwind CSS plugins). Only the default Tailwind CSS configuration is supported.
- Options such as `prefix` and `separator`.
- Object properties (e.g. in `clsx` calls).
Please don't report issues about these features.
:::
## Examples
### Invalid
```jsx
<div class="px-2 foo p-4 bar" />;
<div class="hover:focus:m-2 foo hover:px-2 p-4" />
{
"linter": {
"rules": {
"nursery": {
"useSortedClasses": {
"options": {
"attributes": [
"classList"
],
"functions": [
"clsx",
"cva",
"tw",
"tw.*"
]
}
}
}
}
}
}
Classes in the class and className JSX attributes are always sorted. Use this option to add more attributes that should be sorted.
If specified, strings in the indicated functions will be sorted. This is useful when working with libraries like clsx or cva.
clsx("px-2 foo p-4 bar", {
"some-css-class": condition,
});
clsx("some-css-class", {
"block mx-4": condition,
});
Tagged template literals are also supported, for example:
tw`px-2`;
tw.div`px-2`;
tw`px-2 foo p-4 bar`;
tw.div`px-2 foo p-4 bar`;
:::caution At the moment, this rule does not support customizing the sort options. Instead, the default Tailwind CSS configuration is hard-coded. :::
The main key difference is that Tailwind CSS and its Prettier plugin read and execute the tailwind.config.js JavaScript file, which Biome can't do. Instead, Biome implements a simpler version of the configuration. The trade-offs are explained below.
The rule has no knowledge of values such as colors, font sizes, or spacing values, which are normally defined in a configuration file like tailwind.config.js. Instead, the rule matches utilities that support values in a simpler way: if they start with a known utility prefix, such as px- or text-, they're considered valid.
This has two implications:
False positives: classes can be wrongly recognized as utilities even though their values are incorrect.
For example, if there's a px- utility defined in the configuration, it will match all of the following classes:
px-2, px-1337, px-[not-actually-valid], px-literally-anything.
No distinction between different utilities that share the same prefix: for example,
text-red-500 and text-lg are both interpreted as the same type of utility by this rule,
even though the former refers to a color and the latter to a font size. This results in all
utilities that share the same prefix being sorted together, regardless of their actual values.
The built-in Tailwind CSS preset (enabled by default) contains the set of utilities and variants that are available with the default configuration. More utilities and variants can be added through Tailwind CSS plugins. In Biome, these need to be manually specified in the Biome configuration file in order to "extend" the preset.
In Tailwind CSS, core plugins (which provide the default utilities and variants) can be disabled. In Biome, however, there is no way to disable parts of a preset: it's all or nothing. A work-around is to, instead of using a preset, manually specify all utilities and variants in the Biome configuration file.
The Tailwind CSS Prettier plugin preserves all original whitespace. This rule, however, collapses all whitespace (including newlines) into single spaces.
This is a deliberate decision. We're unsure about this behavior, and would appreciate feedback on it. If this is a problem for you, please share a detailed explanation of your use case in the GitHub issue.