https://github.com/heybourn/headwind

An opinionated Tailwind CSS class sorter built for Visual Studio Code
https://github.com/heybourn/headwind

css formatter sorter tailwind-css tailwindcss visual-studio-code visual-studio-extension

Last synced: about 1 month ago
JSON representation

An opinionated Tailwind CSS class sorter built for Visual Studio Code

• Host: GitHub
• URL: https://github.com/heybourn/headwind
• Owner: heybourn
• License: mit
• Created: 2019-11-20T13:42:25.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-29T15:50:22.000Z (about 1 year ago)
• Last Synced: 2024-05-20T17:36:54.932Z (4 months ago)
• Topics: css, formatter, sorter, tailwind-css, tailwindcss, visual-studio-code, visual-studio-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=heybourn.headwind
• Size: 7.36 MB
• Stars: 1,368
• Watchers: 9
• Forks: 46
• Open Issues: 86
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - headwind

README

        
# Headwind

[![CircleCI](https://circleci.com/gh/heybourn/headwind.svg?style=svg)](https://circleci.com/gh/heybourn/headwind)

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 →](https://marketplace.visualstudio.com/items?itemName=heybourn.headwind)**

**[Use PHPStorm? Get @WalrusSoup's Headwind port →](https://plugins.jetbrains.com/plugin/13376-tailwind-formatter/)**



## Usage

You can install Headwind via the VS Code Marketplace, or package it yourself using [vsce](https://code.visualstudio.com/api/working-with-extensions/publishing-extension). Headwind works globally once installed and will run on save if a `tailwind.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.

## Customisation

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

### `headwind.classRegex`:

An object with language IDs as keys and their values determining the regex to search for Tailwind CSS classes.

The default is located in [package.json](package.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 the `class` string, is created, ensure that it is non-capturing by using `(?:)`.

Example from `package.json`:

```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\\-\\:\\/]*)`)"

}

```

#### Multi-step Regex

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

Example from `package.json`:

```js

"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 JSX `class` or `className` attributes or [twin.macro](https://github.com/ben-rogerson/twin.macro) usage.

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

#### Configuration Object

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 from `package.json`:

```js

"headwind.classRegex": {

    "jade": [

        {

            "regex": "\\.([\\._a-zA-Z0-9\\-]+)",

            "separator": "\\.",

            "replacement": "."

        },

        "\\bclass\\s*=\\s*[\\\"\\']([_a-zA-Z0-9\\s\\-\\:\\/]+)[\\\"\\']"

    ],

}

```

#### Debugging Custom Regex:

To debug custom `classRegex`, you can use the code below:

```js

// Your test string here

const editorText = `

  export const Layout = ({ children }) => (

    


      


      
{children}

    

  )

`

// Your Regex here

const regex = /(?:\b(?:class|className)?\s*=\s*{?[\"\']([_a-zA-Z0-9\s\-\:/]+)[\"\']}?)/

const classWrapperRegex = new RegExp(regex, 'gi')


let classWrapper

while ((classWrapper = classWrapperRegex.exec(editorText)) !== null) {

  const wrapperMatch = classWrapper[0]

  const valueMatchIndex = classWrapper.findIndex((match, idx) => idx !== 0 && match)

  const valueMatch = classWrapper[valueMatchIndex]

  console.log('classWrapper', classWrapper)

  console.log('wrapperMatch', wrapperMatch)

  console.log('valueMatchIndex', valueMatchIndex)

  console.log('valueMatch', valueMatch)

}

```

The result of `valueMatch` should be the class text _exactly_, 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 custom `classRegex`, after each change you should open the control pallete (Ctrl/Cmd + Shift + P) and run `Developer: Reload Window` to ensure changes are applied.



### `headwind.defaultSortOrder`:

An array that determines Headwind's default sort order.

### `headwind.removeDuplicates`:

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

`"headwind.removeDuplicates": false`

### `headwind.prependCustomClasses`:

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

`"headwind.prependCustomClasses": true`

### `headwind.runOnSave`:

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

`"headwind.runOnSave": false`

## Contributing

Headwind is open-source and contributions are always welcome. If you're interested in submitting a pull request, please take a moment to review [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/headwind/contribute)]

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/headwind/contribute)]