如何生成 Checkstyle 报告？

Question

我有一个名为 xml 文件的 checkstyle 报告，并且想要生成一个 html 报告，其中列出了发生了多少次错误以及它们发生在哪些文件中。 像这个例子。

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

Answer 1

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

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

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

我还发现了另一个问题 - 如果您在 checkstyle 插件配置中包含file://协议， mvn checkstyle:checkstyle只会找到您的配置文件，例如

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

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