Evite Commits Problemáticos e Mantenha seu Projeto Limpo

Um commit é um registro das alterações feitas em um projeto por meio de um sistema de controle de versão, como o Git. É importante evitar fazer commits com código quebrado ou com bugs, pois isso pode ter consequências negativas. Esses commits comprometem a qualidade do código, dificultam a manutenção futura, tornam mais complicado o rastreamento de problemas, afetam a integração contínua e prejudicam a reputação do desenvolvedor. Para manter um código de qualidade, facilitar a colaboração e preservar a confiança da equipe, é fundamental evitar commits problemáticos.

Uma maneira eficaz de garantir commits limpos é utilizar o SonarLint. O SonarLint é uma ferramenta de análise de código que auxilia os desenvolvedores a identificar e corrigir problemas de qualidade em tempo real. Ele se integra perfeitamente a ambientes de desenvolvimento populares, destacando problemas no código-fonte e fornecendo sugestões de correção. Essa ferramenta é uma versão local do SonarQube, projetada especificamente para atender às necessidades dos desenvolvedores individuais.

Para saber mais: What is SonarLint?

Como configurar o SonarLint

Primeiramente você vai precisar do Sonar, seja SonarQube (Self-managed) ou SonarCloud (As a service).

A instalação do SonarLint é similar em quase todas IDE:

1. Instale a extensão pelo marketing place da própria IDE
2. Configure a conexão com token.

Para criar um token de usuário no SonarQube ou SonarCloud, siga estes passos:

1. Faça login no SonarQube ou SonarCloud com uma conta de administrador.
2. No painel, clique no ícone do seu avatar no canto superior direito e selecione "My Account" (Minha Conta).
3. Na página "My Account", clique na guia "Security" (Segurança) no menu lateral esquerdo.
4. Role a página até encontrar a seção "Tokens" e clique em "Generate Tokens" (Gerar Tokens).
5. Na página de criação de token, forneça um nome descritivo para o token, que possa identificar seu propósito ou uso.
6. Selecione as permissões que deseja conceder ao token. Você pode optar por Global User Token ou User token (com menos permissão).
7. Após selecionar as permissões, clique em "Generate" (Gerar).
8. O SonarQube irá gerar o token e exibi-lo na tela. Anote o token em um local seguro, pois ele será mostrado apenas uma vez. Tenha cuidado para não perdê-lo, pois você precisará do token para autenticação em API ou integração com outras ferramentas.
9. Após anotar o token, clique em "Done" (Concluído).

Ao incorporar o SonarLint em seu fluxo de trabalho, você poderá identificar problemas de qualidade do código enquanto estiver escrevendo, permitindo que os resolva antes de fazer um commit. Isso ajuda a melhorar a qualidade geral do código, facilita a manutenção futura e evita problemas que possam surgir durante o desenvolvimento. Além disso, commits mais limpos e livres de bugs tornam mais fácil o rastreamento de problemas, promovem uma integração contínua suave e contribuem para a reputação positiva do desenvolvedor e da equipe.