prettier-plugin-tailwind-styled-components 0.0.3 → 1.0.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Onesine
+Copyright (c) 2025 DIMITRI BARBOT
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -2,62 +2,171 @@ A [Prettier](https://prettier.io/) plugin for Tailwind CSS v3.0+ and [Tailwind S
 
 ## Installation
 
-To get started, just install `prettier-plugin-tailwind-styled-components` as a dev-dependency:
+To get started, just install `prettier-plugin-tailwindcss` and `prettier-plugin-tailwind-styled-components` as dev dependencies:
 
 ```sh
-npm install -D prettier prettier-plugin-tailwind-styled-components
+npm install -D prettier prettier-plugin-tailwindcss prettier-plugin-tailwind-styled-components
 ```
 
-This plugin follows Prettier’s autoloading convention, so as long as you’ve got Prettier set up in your project, it’ll start working automatically as soon as it’s installed.
+Then add these plugins to your [Prettier configuration](https://prettier.io/docs/en/configuration.html):
 
-_Note that plugin autoloading is not supported when using certain package managers, such as pnpm or Yarn PnP. In this case you may need to add the plugin to your Prettier config explicitly:_
+```json5
+// .prettierrc
+{
+  "plugins": [
+    "prettier-plugin-tailwindcss",
+    "prettier-plugin-tailwind-styled-components"
+  ]
+}
+```
+
+Make sure `prettier-plugin-tailwind-styled-components` comes after `prettier-plugin-tailwindcss` as it depends on it.
+
+## Upgrading to v0.5.x
 
-```js
-// prettier.config.js
-module.exports = {
-  plugins: [require('prettier-plugin-tailwind-styled-components')],
+As of v0.5.x, this plugin now requires Prettier v3 and is ESM-only. This means it cannot be loaded via `require()`. For more information see our [upgrade guide](https://github.com/tailwindlabs/prettier-plugin-tailwindcss/issues/207#issuecomment-1698071122).
+
+## Options
+
+### Specifying your Tailwind stylesheet path
+
+When using Tailwind CSS v4 you must specify your CSS file entry point, which includes your theme, custom utilities, and other Tailwind configuration options. To do this, use the `tailwindStylesheet` option in your Prettier configuration.
+
+Note that paths are resolved relative to the Prettier configuration file.
+
+```json5
+// .prettierrc
+{
+  "tailwindStylesheet": "./resources/css/app.css"
 }
 ```
 
-## Resolving your Tailwind configuration
+### Specifying your Tailwind JavaScript config path
 
-To ensure that the class sorting is taking into consideration any of your project's Tailwind customizations, it needs access to your [Tailwind configuration file](https://tailwindcss.com/docs/configuration) (`tailwind.config.js`).
+To ensure that the class sorting takes into consideration any of your project's Tailwind customizations, it needs access to your [Tailwind configuration file](https://tailwindcss.com/docs/configuration) (`tailwind.config.js`).
 
 By default the plugin will look for this file in the same directory as your Prettier configuration file. However, if your Tailwind configuration 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
-// prettier.config.js
-module.exports = {
-  tailwindConfig: './styles/tailwind.config.js',
+```json5
+// .prettierrc
+{
+  "tailwindConfig": "./styles/tailwind.config.js"
 }
 ```
 
 If a local configuration file cannot be found the plugin will fallback to the default Tailwind configuration.
 
+## Sorting classes in template literals
+
+To sort classes in template literals as `tailwind-styled-components` you can use the `tailwindFunctions` option, which takes a list of function names:
+
+```json5
+// .prettierrc
+{
+  "tailwindFunctions": ["tw"]
+}
+```
+
+With this configuration, any classes in template literals tagged with `tw` will automatically be sorted:
+
+```jsx
+import tw from "tailwind-styled-components";
+
+export const Container = tw.div`
+  flex
+  flex-col
+  items-center
+  sm:flex-row
+`;
+```
+
+## Preserving duplicate classes
+
+This plugin automatically removes duplicate classes from your class lists. However, this can cause issues in some templating languages, like Fluid or Blade, where we can't distinguish between classes and the templating syntax.
+
+If removing duplicate classes is causing issues in your project, you can use the `tailwindPreserveDuplicates` option to disable this behavior:
+
+```json5
+// .prettierrc
+{
+  "tailwindPreserveDuplicates": true
+}
+```
+
+With this configuration, anything we perceive as duplicate classes will be preserved:
+
+```jsx
+import tw from "tailwind-styled-components";
+
+export const Container = tw.div`
+  flex
+  flex-col
+  items-center
+  sm:flex-row
+  ${({ $isCompact }) => ($isCompact ? "grid-cols-3" : "grid-cols-5")}
+  ${({ $isDark }) => ($isDark ? "bg-black/50" : "bg-white/50")}
+`;
+```
+
+## Specifying tailwind-styled-components import name
+
+By default, this plugins searches for imports such as:
+
+```jsx
+import tw from "tailwind-styled-components";
+```
+
+However, you may want to create your own tailwind styled components library. In that case, your import statement could look like:
+
+```jsx
+import tw from "@/lib/tailwindStyledComponents";
+```
+
+To allow your own import statement to work with this plugin, you have to add this configuration to your prettier configuration file:
+
+```json5
+// .prettierrc
+{
+  "tailwindStyledComponentsImport": "@/lib/tailwindStyledComponents"
+}
+```
+
 ## Compatibility with other Prettier plugins
 
 This plugin uses Prettier APIs that can only be used by one plugin at a time, making it incompatible with other Prettier plugins implemented the same way. To solve this we've added explicit per-plugin workarounds that enable compatibility with the following Prettier plugins:
 
+- `@ianvs/prettier-plugin-sort-imports`
+- `@prettier/plugin-pug`
+- `@shopify/prettier-plugin-liquid`
 - `@trivago/prettier-plugin-sort-imports`
+- `prettier-plugin-astro`
 - `prettier-plugin-css-order`
 - `prettier-plugin-import-sort`
 - `prettier-plugin-jsdoc`
+- `prettier-plugin-multiline-arrays`
 - `prettier-plugin-organize-attributes`
 - `prettier-plugin-organize-imports`
 - `prettier-plugin-style-order`
+- `prettier-plugin-svelte`
+- `prettier-plugin-sort-imports`
 
-One limitation with this approach is that `prettier-plugin-tailwind-styled-components` *must* be loaded last, meaning Prettier auto-loading needs to be disabled. You can do this by setting the `pluginSearchDirs` option to `false` and then listing each of your Prettier plugins in the `plugins` array:
+One limitation with this approach is that `prettier-plugin-tailwindcss` and `prettier-plugin-tailwind-styled-components` _must_ be loaded last.
 
 ```json5
 // .prettierrc
 {
   // ..
   "plugins": [
+    "prettier-plugin-svelte",
     "prettier-plugin-organize-imports",
+    "prettier-plugin-tailwindcss", // MUST come last
     "prettier-plugin-tailwind-styled-components" // MUST come last
-  ],
-  "pluginSearchDirs": false
+  ]
 }
 ```
+
+## Migrating from v0 version
+
+This plugin now relies entirely on the `prettier-plugin-tailwindcss` plugin. You have to add it as a dev-dependency in your `package.json` and add it to your Prettier configuration file plugin section as specified in the [installation](#installation) section.

package/dist/index.mjs

@@ -0,0 +1,9 @@
+import {createRequire as __global__createRequire__} from 'module'
+import {dirname as __global__dirname__} from 'path'
+import {fileURLToPath} from 'url'
+const require=__global__createRequire__(import.meta.url)
+const __filename=fileURLToPath(import.meta.url)
+const __dirname=__global__dirname__(__filename)
+var P=(r=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(r,{get:(t,s)=>(typeof require<"u"?require:t)[s]}):r)(function(r){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+r+'" is not supported')});import*as L from"prettier/plugins/acorn";import*as f from"prettier/plugins/babel";import*as O from"prettier/plugins/flow";import*as k from"prettier/plugins/meriyah";import*as S from"prettier/plugins/typescript";var T=(r,t)=>{let s=(e,a,o,l,i={})=>{if(typeof t=="function"){if(t(e,a,o,l,i)===!1)return}else if(e.type in t&&t[e.type](e,a,o,l,i)===!1)return;let n=Object.keys(e);for(let y=0;y<n.length;y++){let p=e[n[y]];if(Array.isArray(p))for(let u=0;u<p.length;u++)p[u]!==null&&s(p[u],e,n[y],u,{...i});else typeof(p==null?void 0:p.type)=="string"&&s(p,e,n[y],y,{...i})}};s(r)},q=r=>(r==null?void 0:r.type)==="TemplateLiteral"||(r==null?void 0:r.type)==="Template"&&typeof r.value=="string",m=r=>r.replace(/\r\n\t/g," ").replace(/\s+/g," ").trim(),B=(r,t)=>{var s,e;return(r.tag.type==="MemberExpression"&&((s=r.tag.object)==null?void 0:s.type)==="Identifier"&&r.tag.object.name===t||r.tag.type==="CallExpression"&&((e=r.tag.callee)==null?void 0:e.type)==="Identifier"&&r.tag.callee.name===t)&&q(r.quasi)},g=r=>r.endOfLine==="lf"?`
+`:r.endOfLine==="cr"?"\r":r.endOfLine==="crlf"?`\r
+`:"",w=r=>r.useTabs?"	":" ".repeat(r.tabWidth),h=(r,t)=>{let s=g(t),e=w(t);return r.startsWith(s)?r:`${s}${e}${r}`},d=(r,t,s)=>{let e=g(t);if(!r.endsWith(e)){if(s){let a=w(t);return`${r}${e}${a}`}return`${r}${e}`}return r},j=(r,t,s)=>{let e=g(t),a=w(t),o=r.split(" ");return s.splice(0,o.length).join(`${e}${a}`)},A=r=>/[\S]/g.exec(r),C=(r,t,s,e)=>{if(A(r)){let a=m(r);return a=j(a,t,s),a=h(a,t),a=d(a,t,e),a}if(e){let a=m(r);return a=d(a,t,e),a}return r},$=(r,t,s)=>{if(Array.isArray(r.quasis))for(let e=0;e<r.quasis.length;e++){let a=r.quasis[e];a.value&&(a.value.raw=C(a.value.raw,t,s.rawClassList,!a.tail),a.value.cooked=C(a.value.cooked,t,s.cookedClassList,!a.tail))}},x=r=>{if(Array.isArray(r.quasis)){let t=r.quasis.map(i=>{var n;return((n=i.value)==null?void 0:n.raw)||""}).join(""),s=r.quasis.map(i=>{var n;return((n=i.value)==null?void 0:n.cooked)||""}).join(""),a=m(t).split(" "),l=m(s).split(" ");return{rawClassList:a,cookedClassList:l}}return{rawClassList:[],cookedClassList:[]}},_=(r,t)=>e=>{if(!(!e.quasi||!e.tag)&&B(e,t)){let a=x(e.quasi);$(e.quasi,r,a)}},V=(r,t)=>{var o,l;if(!Array.isArray(r.body))return;let s=t.tailwindStyledComponentsImport||"tailwind-styled-components",a=(((o=r.body.find(i=>{var n;return i.type==="ImportDeclaration"&&((n=i.source)==null?void 0:n.value)===s}))==null?void 0:o.specifiers)||[]).find(i=>{var n;return i.type==="ImportDefaultSpecifier"||i.type==="ImportSpecifier"&&((n=i.imported)==null?void 0:n.name)==="default"});return(l=a==null?void 0:a.local)==null?void 0:l.name},I=async(r,t)=>{let s=V(r,t);s&&T(r,_(t,s))},b=(r,t)=>{var l;if(!t.plugins)return r;let s={...r},e="prettier-plugin-tailwindcss",a=null;try{a=P.resolve(e)}catch{return s}let o=t.plugins.find(i=>i.name===e||i.name===a);return o&&Object.assign(s,(l=o.parsers)==null?void 0:l.typescript),s},c=async r=>({...r,preprocess(t,s){let e=b(r,s);return e.preprocess?e.preprocess(t,s):t},async parse(t,s){let a=await b(r,s).parse(t,s);return await I(a,s),a}}),z={babel:c(f.parsers.babel),"babel-flow":c(f.parsers["babel-flow"]),flow:c(O.parsers.flow),typescript:c(S.parsers.typescript),"babel-ts":c(f.parsers["babel-ts"]),acorn:c(L.parsers.acorn),meriyah:c(k.parsers.meriyah),__js_expression:c(f.parsers.__js_expression)},v={},F={tailwindStyledComponentsImport:{type:"string",default:"tailwind-styled-components",category:"Tailwind Styled Components",description:"Tailwind styled components import"}};export{c as createParser,F as options,z as parsers,v as printers};

package/package.json

@@ -1,9 +1,12 @@
 {
+  "type": "module",
   "name": "prettier-plugin-tailwind-styled-components",
-  "version": "0.0.3",
+  "version": "1.0.0",
   "description": "A Prettier plugin for sorting and formatting Tailwind CSS classes when using Tailwind Styled-Components.",
   "license": "MIT",
-  "main": "dist/index.js",
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -19,87 +22,42 @@
     "tailwind-styled-components"
   ],
   "scripts": {
-    "_pre": "rimraf dist",
+    "_pre": "rimraf dist && cpy 'node_modules/tailwindcss/lib/css/*' dist/css",
     "_esbuild": "node build.mjs",
     "prebuild": "yarn _pre",
     "build": "yarn _esbuild --minify",
     "predev": "yarn _pre",
     "dev": "yarn _esbuild --watch",
-    "test": "jest",
-    "prepublishOnly": "yarn build && npm test",
+    "test": "vitest",
+    "prepublishOnly": "yarn build",
     "format": "prettier \"src/**/*.js\" \"tests/test.js\" --write --print-width 100 --single-quote --no-semi --plugin-search-dir ./tests"
   },
   "devDependencies": {
-    "@tailwindcss/line-clamp": "^0.4.2",
-    "@trivago/prettier-plugin-sort-imports": "^3.4.0",
-    "@types/react": "^18.0.26",
-    "@types/react-dom": "^18.0.10",
-    "@types/styled-components": "^5.1.26",
-    "esbuild": "^0.18.0",
-    "escalade": "^3.1.1",
-    "import-fresh": "^3.3.0",
-    "import-from": "^4.0.0",
-    "import-sort-style-module": "^6.0.0",
-    "jest": "^29.3.1",
-    "object-hash": "^3.0.0",
-    "prettier": "^2.8.8",
-    "prettier-plugin-css-order": "^1.3.0",
-    "prettier-plugin-import-sort": "^0.0.7",
-    "prettier-plugin-jsdoc": "^0.4.2",
-    "prettier-plugin-organize-attributes": "^0.0.5",
-    "prettier-plugin-organize-imports": "^3.2.1",
-    "prettier-plugin-style-order": "^0.2.2",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rimraf": "^4.0.7",
-    "styled-components": "^5.3.6",
+    "@types/node": "^22.13.14",
+    "cpy-cli": "^5.0.0",
+    "esbuild": "^0.25.1",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "prettier": "^3.5.3",
+    "prettier-plugin-tailwindcss": "0.6.11",
+    "rimraf": "^6.0.1",
     "tailwind-styled-components": "^2.2.0",
-    "tailwindcss": "^3.2.4",
-    "typescript": "^4.9.4"
+    "tailwindcss": "^4.0.17",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
   },
   "peerDependencies": {
-    "@trivago/prettier-plugin-sort-imports": "*",
-    "prettier": "^2.2 || ^3.0",
-    "prettier-plugin-css-order": "*",
-    "prettier-plugin-import-sort": "*",
-    "prettier-plugin-jsdoc": "*",
-    "prettier-plugin-organize-attributes": "*",
-    "prettier-plugin-organize-imports": "*",
-    "prettier-plugin-style-order": "*",
+    "prettier": "^3.0",
+    "prettier-plugin-tailwindcss": ">=0.6.11",
     "tailwind-styled-components": ">=2.2.0"
   },
-  "peerDependenciesMeta": {
-    "@trivago/prettier-plugin-sort-imports": {
-      "optional": true
-    },
-    "prettier-plugin-css-order": {
-      "optional": true
-    },
-    "prettier-plugin-import-sort": {
-      "optional": true
-    },
-    "prettier-plugin-jsdoc": {
-      "optional": true
-    },
-    "prettier-plugin-organize-attributes": {
-      "optional": true
-    },
-    "prettier-plugin-organize-imports": {
-      "optional": true
-    },
-    "prettier-plugin-style-order": {
-      "optional": true
-    }
-  },
   "engines": {
-    "node": ">=12.17.0"
+    "node": ">=14.21.3"
   },
   "importSort": {
     ".js, .jsx, .ts, .tsx": {
       "style": "module"
     }
-  },
-  "jest": {
-    "testTimeout": 15000
   }
 }

package/CHANGELOG.md

@@ -1,26 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-- Nothing yet!
-
-## [0.0.2] - 2023-01-20
-
-### Fixed
-
-- Fix issue with expression formatting
-
-## [0.0.3] - 2023-07-20
-
-### Fixed
-
-- Add Prettier v3 support
-
-[unreleased]: https://github.com/dimitribarbot/prettier-plugin-tailwind-styled-components/compare/v0.0.3...HEAD
-[0.0.3]: https://github.com/dimitribarbot/prettier-plugin-tailwind-styled-components/compare/v0.0.2...v0.0.3
-[0.0.2]: https://github.com/dimitribarbot/prettier-plugin-tailwind-styled-components/compare/21dc923c300729789a998bbedfbb2f54b7ef04a6...v0.0.2