如何生成 Checkstyle 报告？答案

【问题标题】：How to generate Checkstyle reports?如何生成 Checkstyle 报告？
【发布时间】：2011-06-14 10:31:24
【问题描述】：

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

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

【问题讨论】：

【解决方案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://

【讨论】：