logo
Charcoal

@charcoal-ui/tailwind-diff クイックスタート

npm-badge

インストール

npm

npm install --save-dev @charcoal-ui/tailwind-diff
npx tailwind-diff --help

yarn

yarn add -D @charcoal-ui/tailwind-diff
yarn tailwind-diff --help

あるいは、ローカルにインストールせずに実行するのも良いでしょう。

npx @charcoal-ui/tailwind-diff --help

概要

@charcoal-ui/tailwind-diffは、Tailwind CSSをアップデートした際、または設定をアップデートした際に吐き出されるクラスの差分を表示するCLIツールです。
@charcoal-ui/tailwind-configをアップデートした際のみならず、tailwind-diffはそのままに、Tailwind CSSをアップデートした際に起こる変化を検出し、アップデートを補助します。

使い方

以下のコマンドが実行できます。checkとdumpについては各ページを参照してください。

check
アップデートの結果生じるクラスの差分を出力する
dump
現在の設定からできあがるCSSを出力する

また、サブコマンドなしでも以下のオプションを利用できます

--version
パッケージのバージョンを出力する
--help
使い方のヘルプを出力する
$ npx @charcoal-ui/tailwind-diff --help

tailwind-diff <command>

Commands:
  tailwind-diff check  checks diffs due to package updates
  tailwind-diff dump   dump Tailwind CSS with config

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]