react-genie-cli
v1.0.1
Published
Uma ferramenta CLI para gerar componentes React automaticamente.
Downloads
5
Readme
React Component Genie CLI
React Component Genie CLI é uma ferramenta poderosa para gerar componentes React de forma automatizada. Ela facilita a criação de componentes com diferentes estilos e configurações de teste, permitindo que você escolha entre Tailwind, Styled Components, CSS, Jest, e Playwright.
Instalação
Primeiro, instale a CLI globalmente usando npm:
npm install -g react-component-genie-cli `
Uso
Para usar a CLI, navegue até o diretório raiz do seu projeto React e execute o comando:
genie
A CLI fará uma série de perguntas para configurar seu componente:
- Nome do Componente: O nome do componente que você deseja criar.
- Diretório: O diretório onde o componente será criado.
- Estilo: Escolha entre Tailwind, Styled Components, ou CSS.
- Testes: Escolha entre Jest ou Nenhum.
- TypeScript: Escolha se deseja usar TypeScript.
- Variante: Escolha uma variante de componente (Padrão, Primário, Secundário, Nenhum).
Exemplos
Criar um componente básico com CSS:
genie
Responda às perguntas da CLI:
- Nome do Componente:
Button
- Diretório:
src/components
- Estilo:
CSS
- Testes:
Jest
- TypeScript:
Sim
- Variante:
Nenhum
A CLI criará a estrutura do componente no diretório especificado, incluindo arquivos de estilo e testes.
Estrutura do Projeto
Após gerar um componente, a estrutura do projeto será semelhante a esta:
src/
components/
Button/
Button.tsx
Button.module.css
Button.test.tsx
Configuração de Estilo e Teste
Estilos
- Tailwind: O arquivo de estilo não será criado. Assuma que a configuração do Tailwind já está presente no projeto.
- CSS: Um arquivo
.module.css
será criado. - Styled Components: Um arquivo
.styled.ts
será criado para estilos com styled-components.
Testes
- Jest: Um arquivo de teste utilizando Jest e React Testing Library será criado.
Contribuição
Contribuições são bem-vindas! Siga estas etapas para contribuir:
- Fork o repositório
- Crie sua feature branch (
git checkout -b feature/sua-feature
) - Commit suas mudanças (
git commit -am 'Adiciona nova feature'
) - Faça push para a branch (
git push origin feature/sua-feature
) - Abra um Pull Request
Licença
Este projeto está licenciado sob a licença MIT.