twcn3

A cli utility for converting codebases upgrading from tailwindcss-classnames v2 to v3.

In tailwindcss-classnames v3, you're required to use new utility functions to compose your classes rather than a single classname or tw function. Depending on the size of your codebase, this can be an incredibly time-consuming task.

This utility does it with one command:

npx twcn3 convert

Multiple Directories and/or files

npx twcn3 convert -s layouts
npx twcn3 convert -s pages
npx twcn3 convert -s index.js

Custom Config

npx twcn3 convert -t <path-to-built-types-file>

Custom Import Alias

// sample.tsx

import tailwind from 'tailwindcss-classnames'

npx twcn3 convert -a tailwind

All Options

• --version - Show version number
• --help - Show help
• -t, --types <path-to-types> - The path to your built tailwindcss-classnames types file. Only required if you have custom classes.
• -s, --src <path-to-src> - The path to a directory or file to be converted. (default: src)
• -a, --alias <function-name> - The name used when importing the classnames function from your type file. (i.e. import tw from 'tailwindcss-classnames') (default: tw)