Skip to content

francoismassart/eslint-plugin-tailwindcss

Repository files navigation

eslint-plugin-tailwindcss

eslint-plugin-tailwindcss logo

Version 4 of the eslint-plugin-tailwindcss is:

  • re-written from scratch
  • using TypeScript
  • based on the official plugin prettier-plugin-tailwindcss
  • only compatible with Tailwind CSS v4.x.x

Work in progress

This version is far from finished, yet it is available and open for contributions.

Completed steps

  • restore the automated tests running on the merge requests of the repo

Next steps

  • read the settings from eslint (shared settings & rules settings)
  • create the config utility
  • use the config utility to generate the arguments of generateRules

Getting started

I worked on this repo using pnpm but it should work with other package manager.

Install

pnpm i

Build

pnpm build

Test

pnpm test

or

pnpm test:jest

jest or vitest

Tests were setup to work with jest and vitest both comes with pros and cons...

I would recommend Vitest but I also added Jest in case you want it.

Jest Vitest
Based on commonjs Based on ESM
✅ Mocking ✅ Mocking
✅ Snapshots ✅ Snapshots
✅ Parallel testing ✅ Parallel testing
✅ Fast ✅ Often faster
- ✅ Support benches
❌ Require ts-jest lib ❌ Requires setupFile and vitest.config.ts

NB: In order to use, the RuleTester from @typescript-eslint/rule-tester, we must:

Docs

pnpm docs:init will create new files for each rule if necessary.

pnpm docs:update will update existing files and the rules list.

You can see an example of generated documentation in the next section.

Rules

💡 Manually fixable by editor suggestions.

Name Description 💡
my-rule An example ESLint rule 💡

Additional resources

See eslint-plugin-example-typed-linting for an example plugin that supports typed linting.

🤝 Support eslint-plugin-tailwindcss

🥰 How you can support us? 💪 They did it!
Premium Sponsors
Support us by becoming a sponsor.
Become a recurring sponsor
Current Sponsors
Any amount is appreciated.
@jonz94 @theMosaad @acewf @charkour @dailydotdev @codecov @sourcegraph
Past sponsors
Even if this is just a one-time thing.
Become a backer
@aniravi24 @mongolyy @t3dotgg
Contributors
This project can evolve thanks to all the people who contribute.
You are welcome to contribute to this project by reporting issues, feature requests or even opening Pull Requests.
Supporters
Talk about the plugin on your social networks
eslint-plugin-tailwindcss on Twitter