Guia de Configuração do Checkstyle no Backend (Spring Boot)

[Alan-oliveir]

Este guia mostra como configurar o Checkstyle no projeto backend (Spring Boot) para análise de qualidade de código.

---

1️⃣ Adicionar o plugin no pom.xml

No arquivo pom.xml do backend, dentro da tag <build>, adicione a seguinte configuração:

<build>
    <plugins>
        <!-- Plugin do Checkstyle -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.3.1</version>
            <executions>
                <execution>
                    <id>checkstyle</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <configLocation>checkstyle.xml</configLocation>
                <encoding>UTF-8</encoding>
                <consoleOutput>true</consoleOutput>
                <failsOnError>false</failsOnError> <!-- Não falha o build, apenas exibe avisos -->
            </configuration>
        </plugin>
    </plugins>
</build>

⚠️ O parâmetro failsOnError está definido como false para não bloquear o build no início do projeto.
Mais tarde, o time pode alterar para true para aplicar as regras obrigatoriamente.

---

2️⃣ Criar o arquivo checkstyle.xml

Na raiz do backend, crie um arquivo chamado checkstyle.xml com o seguinte conteúdo:

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
    "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <module name="TreeWalker">
        <!-- Regras básicas -->
        <module name="Indentation">
            <property name="basicOffset" value="4"/>
            <property name="tabWidth" value="4"/>
        </module>
        <module name="LineLength">
            <property name="max" value="120"/>
        </module>
        <module name="EmptyBlock"/>
        <module name="UnusedImports"/>
        <module name="NeedBraces"/>
    </module>
</module>

Essas regras são simples e visam padronizar formatação básica (indentação, imports não utilizados, blocos vazios e chaves obrigatórias).
No futuro, é possível evoluir para regras mais completas, como o Google Java Style.

---

3️⃣ Executar o Checkstyle localmente

Para verificar o código localmente, execute no terminal:

mvn checkstyle:check

Isso irá analisar o código e mostrar avisos no terminal sem bloquear a build.

---

4️⃣ Integração com GitHub Actions

O nosso workflow de CI já está configurado para executar o Checkstyle no backend.

Trecho do ci.yml:

- name: Run Lint (backend - Checkstyle)
  run: |
    cd backend
    mvn checkstyle:check || echo "Checkstyle warnings only"

No CI, o Checkstyle só gera avisos e não bloqueia Pull Requests.
Isso serve apenas como feedback para o time durante o desenvolvimento.

---

✅ Próximos passos sugeridos:

• Ajustar o código conforme os avisos do Checkstyle.
• Adicionar regras mais específicas no futuro (ex.: Google Java Style).
• Avaliar a possibilidade de tornar o failsOnError obrigatório quando o time estiver confortável.