trdr-cli
v0.1.0
Published
CLI de manutencao do design system TRDR: doctor (drift de componentes ejetados), diff (contra o registry) e migrate (codemod de classes trdr-* legadas).
Maintainers
Readme
trdr-cli
Manutenção do design system TRDR dentro de um projeto que consome o trdr-ui.
O shadcn já resolve o "copiar componente para o projeto". O que ele não tem é o caminho de
atualização: descobrir o que ficou para trás depois que o componente foi ejetado, ver o que mudou
no registry desde então, e trocar as classes legadas trdr-* pelo equivalente atual. É só para
isso que este CLI existe.
Uso
Sem instalar nada:
npx trdr-cli doctorOu como dependência de desenvolvimento, quando o comando entra no package.json do projeto:
npm i -D trdr-cliO binário se chama trdr-cli, igual ao pacote. É de propósito: trdr-ui é o nome da
biblioteca no npm, então um binário com esse nome faria npx trdr-ui doctor baixar a
biblioteca, que não tem executável, em vez deste CLI.
Comandos
doctor
Verifica a versão dos pacotes TRDR instalados e o drift dos componentes ejetados em relação ao registry.
trdr-cli doctor
trdr-cli doctor --json| Opção | Padrão | O que faz |
|---|---|---|
| --cwd <caminho> | diretório atual | diretório do projeto a verificar |
| --dir <caminho> | components/ui | pasta dos componentes ejetados |
| --home <url> | https://trdr.mrocontent.com.br | origem do registry |
| --json | | imprime o relatório em JSON em vez de texto |
diff
Mostra o diff entre um componente ejetado no projeto e a versão atual no registry.
trdr-cli diff button
trdr-cli diff order-ticket --context 6| Opção | Padrão | O que faz |
|---|---|---|
| --cwd <caminho> | diretório atual | diretório do projeto |
| --dir <caminho> | components/ui | pasta dos componentes ejetados |
| --home <url> | https://trdr.mrocontent.com.br | origem do registry |
| --context <n> | 3 | linhas de contexto ao redor de cada mudança |
migrate
Codemod das classes legadas trdr-* para o equivalente em Tailwind e trdr-ui.
trdr-cli migrate src --dry-run
trdr-cli migrate src| Opção | Padrão | O que faz |
|---|---|---|
| --dry-run | | mostra o que faria, sem escrever nada em disco |
| --force | | roda mesmo com o git sujo, ou fora de um repositório git |
| --cwd <caminho> | diretório atual | diretório de trabalho para a checagem do git |
| --home <url> | https://trdr.mrocontent.com.br | origem do tokens.json e do mappings.json |
O migrate se recusa a rodar com o working directory do git sujo, ou fora de um repositório: sem
isso não há como desfazer. Use --force para assumir o risco, ou --dry-run para só olhar.
Requisitos
Node 20 ou superior.
Licença
MIT
