tailwindcss-class-sorter

A tailwindcss class sorter that respects tailwind config file.

Installation

$ npm install @shufo/tailwindcss-class-sorter
# yarn
$ yarn add @shufo/tailwindcss-class-sorter

Usage

// CommonJS
const { sortClasses } = require("@shufo/tailwindcss-class-sorter");

const sorted = sortClasses("pt-2 p-4");
console.log(sorted);
// => "p-4 pt-2"

// ESModule
import { sortClasses } from "tailwindcss-class-sorter";
const sorted = sortClasses("pt-2 p-4");

tailwindcss-class-sorter will automatically look for tailwind.config.js in the project directory. Then if it exists, it will sort according to the tailwindcss configuration. If it does not exist, the default sort order of tailwindcss plugin will be used.

API

functions

sortClasses(classes: string, options: IOption)

classes: classes string e.g. z-5 z-50

Interfaces

IOption

export interface IOption {
  tailwindConfigPath?: string;
  tailwindConfig?: TailwindConfig;
}

| key | value | | ------------------ | ----------------------------------------- | | tailwindConfigPath | A path to tailwind config file | | tailwindConfig | A configuration object of tailwind config |

Testing

$ yarn install
$ yarn run test

Benchmarking

$ yarn run benchmark

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

LICENSE

MIT