cnat 0.0.2

Systematically apply certain modifications to classes, class names, used in your frontend codebase.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

[![crates.io](https://img.shields.io/crates/v/cnat.svg)](https://crates.io/crates/cnat)
[![npm version](https://img.shields.io/npm/v/cnat.svg)](https://www.npmjs.com/package/cnat)

# CNAT

Class Name Alteration Tool. Systematically change all the class names in your codebase.

## Install

```sh
cargo install cnat
```

```sh
npm install -g cnat
```

## Why?

Because you joined a project that has some awful old tailwind configs: weird bespoke spacing configuration,
weird sizes, some current tailwind default colors (e.g. slate) not available because the config was for an older version
of tailwind, etc...

So now you can't just copy/paste tailwind class names from the internet or use ones that come from a ui component library.
Say you want to use [shadcn/ui](https://ui.shadcn.com/); Nope!

You want to do something about this, but it's way too risky and time consuming. You would want to do this incrementally, to protect your
sanity.

The best solution would be to deprecate the old configs while keeping them around and working; so you slap a prefix `legacy-`
in the old `tailwind.config.js`.

## Deprecation Steps

In the root of your project. Run:

```sh
npx tailwindcss -i <(echo '@tailwind utilities;') -o legacy-tw.css
cnat prefix -i legacy-tw.css --prefix 'legacy-' .
```

By default, `cnat prefix` will crawl through all the `class=*`, `className=*` in jsx elements and `className:*` in a `React.createElement` calls, inside of `ts|js|tsx|jsx` files.
It will match any class in the source code with classes found in `legacy-tw.css` (which contains every style that tailwind generates based on your config).

Add the prefix in the legacy config file.

```js
/** @type {import('tailwindcss').Config} */
module.exports = {
  prefix: "legacy-",
};
```

Then update your global css with the tailwind directives. Create a new file for the old configs, `tailwind.legacy.config.js`.
Then, create an additional css file which the tailwind directives as such:

`./legacy-tw.css`

```css
@config "./tailwind.legacy.config.js";
@tailwind base;
@tailwind components;
@tailwind utilities;
```

`@config` requires tailwind v3.2 btw.

Import that css file in where-ever the entry point for your project is. For example in Nextjs, you can add it to the `_app.tsx` file (pages directory version).

```ts
import "./legacy-tw.css";
```

## Usage

```
Systematically apply certain modifications to classes, class names, used in your frontend codebase.

Usage: cnat <COMMAND>

Commands:
  prefix      Apply a prefix to all the tailwind classes in every js file in a project
  completion  Generate completions for a specified shell
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version
```

```sh
cnat prefix --help
```

```
Apply a prefix to all the tailwind classes in every js file in a project

Usage: cnat prefix [OPTIONS] -i <CSS_FILE> --prefix <PREFIX> <CONTEXT>

Arguments:
  <CONTEXT>  The root directory of the js/ts project

Options:
  -i <CSS_FILE>             The output css file generated by calling `npx tailwindcss -i input.css -o output.css`
  -p, --prefix <PREFIX>     The prefix to apply to all the tailwind class names found
  -s, --scopes <SCOPES>...  Define scope within which prefixing happens. Example: --scopes 'att:className,*ClassName prop:classes fn:cva' [default: "att:class,className fn:createElement"]
  -h, --help                Print help
```