java - 如何生成 Checkstyle 报告？

Question

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

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

Answer 1

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

摘要 html 文件位于目标目录中，但是我发现缺少图像和 CSS，因此看起来很糟糕。

mvn site 将生成类似于您的图像的 HTML 格式报告。但同时也会产生大量的其他报表 Material ，耗时较长。

我还发现了另一个问题 - 如果您在 checkstyle 插件配置中包含 file:// 协议(protocol)，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://