devio-cli
v1.0.68
Published
Devio CLI to generate quality code and setup sonarqube in your project
Downloads
2,068
Readme
Devio CLI
Devio CLI é uma ferramenta de linha de comando desenvolvida para automatizar a configuração de pacotes e garantir a qualidade de código em projetos. Esta ferramenta utiliza integração com SonarQube e outros utilitários para melhorar a gestão e validação de código.
Guia
- Guia de instalação e uso (Link do YouTube).
- Estrutura de código (Link do YouTube).
Funcionalidades
- Configuração automática de pacotes essenciais e integração com SonarQube.
- Validação da qualidade de código com linting e formatação.
- Configuração automatizada para Git, incluindo hooks de pré-commit e integração com GitLab/GitHub.
- Scripts auxiliares para instalação de pacotes e manutenção de arquivos de configuração.
Etapas da execução
1- Solicitação das execuções de administrador para realizar mudanças.
2- Identificação do pacote utilizado pelo projeto (yarn, npm e etc).
3- Identificação do ambiente.
4- Solicitação para instalar as libs de configuração (Eslint, husky, prettier e etc).
5- Solicitação para gerar arquivos de configuração das libs instaladas anteriormente.
6- Instalação da lib de commits de forma global.
7- Configuração do SonarQube.
7.1- Inserir dados do projeto de será criado.
7.2- Solicitação para adicionar os hooks ao husky
7.3- Solicitação de primeira execução do sonar
Limitações
- A biblioteca possui uso limitado para os seguintes projetos:
- Node: >=16
- Next: >=11
- React >=16
- React-Native (CLI): >=0.7
Importante
Devido a atualização constante de versões, algumas podem apresentar instabilidade. Por favor, caso encontre alguma abra um pull request com as correções.
Uso
Execute o comando principal para configurar o projeto:
npx devio-cli
Após isso a CLI perguntará quais instalações deseja realizar
Se a configuração for bem-sucedida, você verá a mensagem:
Setup finalizado com sucesso
Caso haja um erro, a seguinte mensagem será exibida:
Falha ao configurar setup: <mensagem de erro>
Dependências
As principais dependências estão definidas no package.json
:
- inquirer: Utilizado para criar prompts interativos na linha de comando.
Licença
Este projeto está licenciado sob a licença MIT.
Autor
- Igor Rezende
Contact
- [email protected] (org)
- [email protected] (personal)