prettier-plugin-tailwindcss - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "prettier-plugin-tailwindcss",
-  "version": "0.1.0",
-  "description": "",
+  "version": "0.1.1",
+  "description": "A Prettier plugin for sorting Tailwind CSS classes.",
   "main": "dist/index.js",
@@ -6,0 +6,0 @@ "files": [

README.md

@@ -5,5 +5,7 @@ # prettier-plugin-tailwindcss
 
+> Note, this plugin is only compatible with Tailwind CSS v3.
+
 ## Installation
 
-> Note that `prettier-plugin-tailwindcss` is only compatible with Tailwind CSS v3
+Install `prettier-plugin-tailwindcss` via npm as a dev-dependency.
 
@@ -14,4 +16,10 @@ ```sh
 
-By default the plugin will look for a [Tailwind config file (`tailwind.config.js`)](https://tailwindcss.com/docs/configuration) in the same directory as your Prettier config file. If your Tailwind config file is somewhere else you can specify this using the `tailwindConfig` option (paths are resolved relative to the Prettier config file):
+This plugin follows the Prettier autoloading convention, so once it's installed it should automatically start working.
 
+## Resolving your Tailwind configuration
+
+By default this plugin will look for a [Tailwind configuration file](https://tailwindcss.com/docs/configuration) (`tailwind.config.js`) in the same directory as your Prettier configuration file.
+
+If your Tailwind configuration file is somewhere else, you can specify this using the `tailwindConfig` option in your Prettier configuration. Note that paths are resolved relative to the Prettier configuration file.
+
 ```js
@@ -24,2 +32,8 @@ // prettier.config.js
 
-_If a Tailwind config file cannot be found then the default Tailwind configuration will be used._
+If a Tailwind configuration file cannot be found then the default Tailwind configuration will be used.
+
+## Compatibility with other Prettier plugins
+
+To make this plugin work, we had to build it in a way that the Prettier plugin system was not designed for. We had to extend the core parsers in Prettier with our own custom parsers. And while this works, it makes this plugin incompatible with other Prettier plugins that are build the same way. This is a known limitation of Prettier.
+
+One example of this incompatibility is with the [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte) plugin. It's not possible to use the Svelte plugin at the same time as the Tailwind CSS plugin. However, as a workaround, we bundled the Svelte plugin into this plugin. Simply remove `prettier-plugin-svelte` from your Svelte project when installing the `prettier-plugin-tailwindcss` plugin, and everything should work fine.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

663765

increased by0.18%

Number of lines in readme file

37

increased by60.87%

No dependency changes