https://github.com/idered/eslint-plugin-tailwind

ESLint rules for Tailwind CSS
https://github.com/idered/eslint-plugin-tailwind

eslint eslint-rules tailwind tailwind-css tailwindcss

Last synced: 26 days ago
JSON representation

ESLint rules for Tailwind CSS

• Host: GitHub
• URL: https://github.com/idered/eslint-plugin-tailwind
• Owner: Idered
• License: mit
• Created: 2020-01-04T13:50:05.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T21:58:05.000Z (over 2 years ago)
• Last Synced: 2024-09-23T14:04:04.436Z (about 1 month ago)
• Topics: eslint, eslint-rules, tailwind, tailwind-css, tailwindcss
• Language: JavaScript
• Size: 380 KB
• Stars: 100
• Watchers: 6
• Forks: 7
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-tailwind



  



![npm (scoped)](https://img.shields.io/npm/v/eslint-plugin-tailwind?style=for-the-badge) ![npm bundle size (scoped)](https://img.shields.io/npm/l/eslint-plugin-tailwind?style=for-the-badge)

ESLint rules for [Tailwind CSS](https://tailwindcss.com/)

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-tailwind`:

```

$ npm install eslint-plugin-tailwind --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-tailwind` globally.

## Usage

Extend your ESLint config with tailwind config:

```json

{

  "extends": ["plugin:tailwind/recommended"]

}

```

## Supported Rules

- [`tailwind/class-order`](docs/rules/class-order.md)

## Supported languages and file extensions

- HTML - `html`

- React - `js`, `jsx`, `tsx`

## VS Code integration

See [/example/.vscode](./example/.vscode) directory for recommended project settings.

## Roadmap

- [ ] Handle responsive prefixes - `sm`, `md` etc.

- [ ] Handle pseudo classes - `hover`, `active` etc.

- [ ] Add support for Vue

- [ ] Add support for Svelte

- [ ] Add support for Angular