如何生成Checkstyle报告？

Question

我有一个checkstyle报告作为XML文件，并希望生成一个HTML报告，其中列出了发生了多少次错误和在哪些文件中发生的错误。像这样的example。

有没有工具可以做到这一点？

Answer 1

如果您使用mvn来执行此操作，mvn checkstyle:checkstyle将生成xml格式的报告，或者使用-Dcheckstyle.output.format=plain选项仅显示纯文本。这两个只会列出错误，并不会给出任何总结。

在目标目录中找到摘要html文件，但是我发现图像和CSS都丢失了，所以看起来很糟糕。

mvn site将生成像您的图像的HTML格式报告。但是它也会产生大量的其他报告材料，并且需要很长时间。

我也发现了另外一个问题 - mvn checkstyle:checkstyle只有在checkstyle插件配置中包含file://协议才能找到你的配置文件，例如：

<plugin> 
    <artifactId>maven-checkstyle-plugin</artifactId> 
    <version>2.13</version> 
    <configuration> 
     <configLocation>file://${basedir}/checkstyle/checkstyle.xml</configLocation> 
    </configuration> 
    </plugin> 

然而mvn site只需要一个目录，而不能处理file://