Devio Sonar

Este projeto automatiza a configuração de um arquivo sonar-project.properties e um arquivo de pipeline para GitLab CI com SonarQube. O objetivo é facilitar a integração com o SonarQube para monitorar a qualidade do código do seu projeto.

Pré-requisitos

Antes de começar, certifique-se de que você atendeu aos seguintes requisitos:

• Node.js instalado em sua máquina (versão 12 ou superior).
• Possuir o repositório e acessar a pasta raiz do projeto

Como Usar

1. Para iniciar a configuração do SonarQube no seu projeto, execute o comando abaixo na raiz do seu projeto:

   npx devio-sonar

2. O script solicitará algumas informações necessárias para configurar o SonarQube:

   • Nome do Projeto: Nome que será utilizado no SonarQube. Use um nome sugestivo EX: olx_frontend
   • Caminho para o Diretório Raiz: Diretório do código que será analisado. O padrão é ./src. Altere somente se a SRC não for sua pasta principal ou não estiver na raiz do seu projeto.
   • Nome do Arquivo YML: Nome do arquivo de pipeline CI (padrão é .gitlab-ci). Por padrão o GitLab reconhece apenas esse arquivo, atenção se for trocar
   • Branches para Monitorar: Lista de branches que você deseja que o GitLab CI monitore, separadas por vírgula. Por padrão, main e develop estão incluídos e não é possível remove-lás.

3. Se o arquivo sonar-project.properties ou o arquivo YML do GitLab já existir, o script perguntará se você deseja sobrescrevê-los.

4. Após a configuração, o arquivo sonar-project.properties será criado, e o pipeline CI no arquivo YML também será gerado com a configuração para rodar o SonarQube nas branches definidas.

Estrutura do Projeto

• sonar-project.properties: Arquivo gerado automaticamente contendo as propriedades do projeto SonarQube.
• Arquivo YML do GitLab CI: O nome e local do arquivo YML serão baseados nas suas escolhas durante a execução do script.

Exemplo de Comandos

Rodando o script

npx devio-sonar

Parâmetros Solicitados

• Nome do Projeto: meu_projeto_sonar_backend
• Caminho para o Diretório Raiz: ./src
• Nome do Arquivo YML: .gitlab-ci
• Branches para Monitorar: feature

API SonarQube

O script utiliza a API do SonarQube para verificar se o projeto já existe antes de tentar sobrescrevê-lo. A consulta é feita através do endpoint /api/projects/search. Caso ele identifique ele perguntará se você deseja sobrescrever, caso o projeto que está sendo configurado não seja o mesmo do existente, cancele e rode o comando novamente inserindo um novo nome.

Licença

Este projeto é licenciado sob a licença MIT.

NPM

Link da lib:

https://www.npmjs.com/package/devio-sonar