npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-tailwindcss-jsx

v0.0.1

Published

A ESLint plugin to enforce TailwindCSS best practices.

Downloads

7

Readme

An ESLint plugin for Tailwind CSS v3.0+ that enforces best practices and consistency with focus on ReactJS (.jsx & .tsx).

📩 Installation

To get started, just install eslint-plugin-tailwindcss-jsx as a dev-dependency:

npm install -D eslint eslint-plugin-tailwindcss-jsx

It is also possible to install ESLint globally rather than locally (using npm install -g eslint). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.

⚙️ Configuration

.eslintrc.[js/json]

Use our preset to get reasonable defaults:

// ..
  "extends": [
    "eslint:recommended",
    "plugin:tailwindcss-jsx/recommended"
  ]
// ..

You should also specify settings that will be shared across all the plugin rules. (More about eslint shared settings)

{
  "settings": {
    "tailwindConfigPath": "tailwind.config.js", // Relative path to the TailwindCSS config file from the root directory
    "attributesRegex": /\b(class|className)\b/g.source, // Regex to match Attribute Nodes that contain TailwindCSS class names
    "calleesRegex": /\b(clsx|cls|classnames)\b/g.source, // Regex to match Call Expression Nodes that contain TailwindCSS class names
    "tagsRegex": /\b(tss)\b/g.source, // Regex to match Tag Expression Nodes that contain TailwindCSS class names
  }
}

If you do not use a preset you will need to specify individual rules and add extra configuration.

Add tailwindcss-jsx to the plugins section:

// ..
  "plugins": [
    "tailwindcss-jsx",
  ]
// ..

Enable JSX support

// ..
"parserOptions": {
    "ecmaFeatures": {
      "jsx": true
  }
}
// ..

Enable the rules that you would like to use:

// ..
  "plugins": [
    "tailwindcss-jsx/sort-classes": "error",
  ]
// ..

Sharable configs

Recommended

This plugin exports a recommended configuration that enforces TailwindCSS best practices. To enable this configuration use the extends property in your .eslintrc config file:

// ..
"extends": ["eslint:recommended", "plugin:tailwindcss-jsx/recommended"]
// ..

See eslint documentation for more information about extending configuration files.

Note: These configurations will enable JSX in parser options.

eslint.config.js

coming soon

📜 List of supported rules

  • ☑️ Set in the recommended configuration
  • 🔧 Automatically fixable by the --fix CLI option

| Name                                 | Description | ☑️ | 🔧 | | :---------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | :- | :- | | sort-classes | Enforces consistent order of TailwindCSS class names based on the officially recommended class name order. | ☑️ | 🔧 | | extract-classes | Enforces the extraction of TailwindCSS class names if an identifier like extract-[Container] is present. | | 🔧 |

🆔 License

eslint-plugin-tailwindcss-jsx is licensed under the MIT License.

🙏 Contribution

📒 Resources

🔴 Debug via Jest Test

  1. Start Javascript Debug Terminal
  2. Set 🔴 Debug Point
  3. Run test via pnpm run test --watch, for example:
    pnpm run test -- extract-tailwind --watch

🌟 Credits