https://github.com/avencera/rustywind

CLI for organizing Tailwind CSS classes
https://github.com/avencera/rustywind

cli hacktoberfest tailwind-css tailwindcss

Last synced: 29 days ago
JSON representation

CLI for organizing Tailwind CSS classes

• Host: GitHub
• URL: https://github.com/avencera/rustywind
• Owner: avencera
• License: apache-2.0
• Created: 2019-11-22T14:17:42.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-06T15:58:02.000Z (about 1 month ago)
• Last Synced: 2024-10-11T15:06:27.513Z (about 1 month ago)
• Topics: cli, hacktoberfest, tailwind-css, tailwindcss
• Language: Rust
• Homepage:
• Size: 949 KB
• Stars: 471
• Watchers: 6
• Forks: 26
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-js-tooling-in-rust - rustywind
• awesome-tailwindcss - RustyWind - CLI tool for sorting Tailwind CSS classes. (Tools)

README

        
# RustyWind [![Mean Bean CI](https://github.com/avencera/rustywind/workflows/Mean%20Bean%20CI/badge.svg)](https://github.com/avencera/rustywind/actions?query=workflow%3A%22Mean+Bean+CI%22) [![npm version](https://badge.fury.io/js/rustywind.svg)](https://badge.fury.io/js/rustywind) [![crates.io](https://img.shields.io/crates/v/rustywind.svg)](https://crates.io/crates/rustywind)

## Install

Available via npm

`yarn global add rustywind`

or

`npm install -g rustywind`

or

Install from homebrew (mac and linux):

`brew install avencera/tap/rustywind`

or

Install from crates.io:

`cargo install rustywind`

or

`cargo binstall rustywind`

or

Install from a github release:

`curl -LSfs https://avencera.github.io/rustywind/install.sh | sh -s -- --git avencera/rustywind`

or

Download a release directly from github: [github.com/avencera/rustywind/releases](https://github.com/avencera/rustywind/releases)

or

You can use the dockerized version

`docker run --rm -v $PWD:/app avencera/rustywind:latest `

## Usage

Run rustywind with a path to output updated file contents to the terminal:

- `rustywind .`

If you want to reorganize all classes in place, and change the files run with the `--write` flag

- `rustywind --write .`

Run rustywind with a path and the `--dry-run` to get a list of files that will be changed:

- `rustywind --dry-run .`

Run rustywind on your STDIN:

- `echo "" | rustywind --stdin`

Run in CI, exit with error if unsorted classes are found:

- `rustywind --check-formatted .`

Run RustyWind with a custom sorter. The `config_file.json` should have a top level entry of `sortOrder`

which is an array with the classes listed in the order you want them sorted.

- `rustywind --config-file config_file.json`

Use with tailwind prettier plugin

- `rustywind --output-css-file `

- `rustywind --vite-css `

```shell

Usage: rustywind [OPTIONS] [PATH]...

Run rustywind with a path to get a list of files that will be changed

  rustywind . --dry-run

If you want to reorganize all classes in place, and change the files run with the `--write` flag

  rustywind --write .

To print only the file names that would be changed run with the `--check-formatted` flag

  rustywind --check-formatted .

If you want to run it on your STDIN, you can do:

  echo "" | rustywind --stdin

Arguments:

  [PATH]...

          A file or directory to run on

Options:

      --stdin

          Uses stdin instead of a file or folder

      --write

          Changes the files in place with the reorganized classes

      --dry-run

          Prints out the new file content with the sorted classes to the terminal

      --check-formatted

          Checks if the files are already formatted, exits with 1 if not formatted

      --allow-duplicates

          When set, RustyWind will not delete duplicated classes

      --config-file 

          When set, RustyWind will use the config file to derive configurations. The config file current only supports json with one property sortOrder, e.g. { "sortOrder": ["class1", ...] }

      --output-css-file 

          When set RustyWind will determine the sort order by the order the class appear in the the given css file

      --vite-css 

          When set RustyWind will determine the sort order by the order the class appear in the CSS file that vite generates.

          Please provide the full URL to the CSS file ex: `rustywind --vite-css "http://127.0.0.1:5173/src/assets/main.css" . --dry-run`

          Note: This option is experimental and may be removed in the future.

      --skip-ssl-verification

          When set, RustyWind will skip SSL verification for the vite_css option

      --ignored-files 

          When set, RustyWind will ignore this list of files

      --custom-regex 

          Uses a custom regex instead of default one

      --quiet

          Do not print log messages

  -h, --help

          Print help (see a summary with '-h')

  -V, --version

          Print version

```

## What

Inspired by [Ryan Heybourn's](https://github.com/heybourn) [headwind](https://github.com/heybourn/headwind)

vscode plugin. This is a CLI tool that will look through your project and sort all [Tailwind CSS](https://tailwindcss.com) classes.

It will also delete any duplicate classes it finds.