Apache Maven: customizar o relatório Checkstyle
Neste artigo mostrarei como customizar o relatório Checkstyle.
Porém, antes de proceguir, recomendo que veja os artigos anteriores.
Pois bem.
O relatório Checkstyle, por padrão, processa e apresenta TODAS as entradas como erro. Entretanto, alguns dos itens não necessariamente são erros: os itens relacionados a formatação, por exemplo. É claro que isso pode variar para cada empresa, cada profissional.
Diante desse meu argumento, apresentarei uma forma de customizar o relatório gerado pelo Checkstyle.
Em nosso projeto POM, adicionaremos uma entrada na configuração do plugin “maven-checkstyle-plugin”. Editem o arquivo pom.xml do projeto POM e façam com que a configuração fique como abaixo.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<configLocation>${basedir}/src/site/checkstyle/checkstyle-custom.xml</configLocation>
</configuration>
</plugin>
Nesse exemplo, adicionamos a entraca “configuration” direcionando para um arquivo específico chamado “checkstyle-costom.xml”.
Salve o arquivo, incremente a versão (deve ser a 1.5, imagino) do POM e faça o deploy.
mvn install
Após esse procedimento, copie o arquivo “checkstyle-custom.xml” no projeto BASE (esse arquivo contém algumas alterações que movem o restuldado “error” para “info”, por exemplo).
Edite o arquivo pom.xml do projeto BASE e atualize a referência para o projeto POM. Gere o site.
mvn site
Veja o resultado gerado para o relatório do Checkstle.
Comparem com a primeira versão de relatório gerado pelo Checksyle e notem as diferenças. Nesta nova versão, muitos erros foram desconsiderados e entradas do tipo “info” foram apresentadas.
Arquivos POM
Até este momento, temos as seguintes versões dos arquivos POM:
