Repository files navigation

Headwind is an opinionated Tailwind CSS class sorter for Visual Studio Code. It enforces consistent ordering of classes by parsing your code and reprinting class tags to follow a given order.

Headwind runs on save, will remove duplicate classes and can even sort entire workspaces.

Get it from the VS Code Marketplace →

Use PHPStorm? Get @WalrusSoup's Headwind port →

You can install Headwind via the VS Code Marketplace, or package it yourself usingvsce. Headwind works globally once installed and will run on save if atailwind.config.js file is present within your working directory.

You can also trigger Headwind by:

• Pressing ALT + Shift + T on Mac
• Pressing CTRL + ALT + T on Windows
• Pressing CTRL + ALT + T on Linux

Headwind can sort individual files by running 'Sort Tailwind CSS Classes' via the Command Palette. Workspaces can also be sorted by running 'Sort Tailwind CSS Classes on Entire Workspace'.

Any breakpoints or unknown classes will be moved to the end of the class list, whilst duplicate classes will be removed.

Headwind ships with a default class order (located inpackage.json). You can edit this (and other settings) to your liking on the extension settings page.

An object with language IDs as keys and their values determining the regex to search for Tailwind CSS classes.The default is located inpackage.json but this can be customized to suit your needs.

There can be multiple capturing groups, that should only contain a string with Tailwind CSS classes (without any apostrophies etc.). If a new group, which doesn't contain theclass string, is created, ensure that it is non-capturing by using(?:).

Example frompackage.json:

"headwind.classRegex": {"html":"\\bclass\\s*=\\s*[\\\"\\']([_a-zA-Z0-9\\s\\-\\:\\/]+)[\\\"\\']","javascriptreact":"(?:\\bclassName\\s*=\\s*[\\\"\\']([_a-zA-Z0-9\\s\\-\\:\\/]+)[\\\"\\'])|(?:\\btw\\s*`([_a-zA-Z0-9\\s\\-\\:\\/]*)`)"}

A multi-step regex can be specified by using an array of regexes to be executed in order.

Example frompackage.json:

"headwind.classRegex":{"javascript":["(?:\\bclass(?:Name)?\\s*=\\s*(?:{([\\w\\d\\s_\\-:/${}()[\\]\"'`,]+)})|([\"'`][\\w\\d\\s_\\-:/]+[\"'`]))|(?:\\btw\\s*(`[\\w\\d\\s_\\-:/]+`))","(?:[\"'`]([\\w\\d\\s_\\-:/${}()[\\]\"']+)[\"'`])"],}

The first regex will look for JSXclass orclassName attributes ortwin.macro usage.

The second regex will then look for class names to be sorted within these matches.

Optionally a configuration object can be passed to specify additional options for sorting class names.

• regex - specifies the regex to be used to find class names
• separator - regex pattern that is used to separate class names (default:"\\s+")
• replacement - string used to replace separator matches (default:" ")

Example frompackage.json:

"headwind.classRegex":{"jade":[{"regex":"\\.([\\._a-zA-Z0-9\\-]+)","separator":"\\.","replacement":"."},"\\bclass\\s*=\\s*[\\\"\\']([_a-zA-Z0-9\\s\\-\\:\\/]+)[\\\"\\']"],}

To debug customclassRegex, you can use the code below:

// Your test string hereconsteditorText=`  export const Layout = ({ children }) => (    <div>      <div className="w-64 h-full bg-blue-400 relative"></div>      <div>{children}</div>    </div>  )`// Your Regex hereconstregex=/(?:\b(?:class|className)?\s*=\s*{?[\"\']([_a-zA-Z0-9\s\-\:/]+)[\"\']}?)/constclassWrapperRegex=newRegExp(regex,'gi')letclassWrapperwhile((classWrapper=classWrapperRegex.exec(editorText))!==null){constwrapperMatch=classWrapper[0]constvalueMatchIndex=classWrapper.findIndex((match,idx)=>idx!==0&&match)constvalueMatch=classWrapper[valueMatchIndex]console.log('classWrapper',classWrapper)console.log('wrapperMatch',wrapperMatch)console.log('valueMatchIndex',valueMatchIndex)console.log('valueMatch',valueMatch)}

The result ofvalueMatch should be the class textexactly, with no other characters.

Good example value:valueMatch w-64 h-full bg-blue-400 relative

Note: Changes made to Headwind's JSON configuration options may not take effect immediately. When experimenting with customclassRegex, after each change you should open the control pallete (Ctrl/Cmd + Shift + P) and runDeveloper: Reload Window to ensure changes are applied.

An array that determines Headwind's default sort order.

Headwind will remove duplicate class names by default. This can be toggled on or off.

"headwind.removeDuplicates": false

Headwind will append custom class names by default. They can be prepended instead.

"headwind.prependCustomClasses": true

Headwind will run on save by default (if atailwind.config.js file is present within your working directory). This can be toggled on or off.

"headwind.runOnSave": false

Headwind is open-source and contributions are always welcome. If you're interested in submitting a pull request, please take a moment to reviewCONTRIBUTING.md.

This project exists thanks to all the people who contribute. [Contribute].

Become a financial contributor and help us sustain our community. [Contribute]

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]