如何定义 checkstyle 的抑制定义，可与 ant 和 eclipse 一起使用

Question

我在项目中使用 checkstyle 并在 checkstyle 配置中定义了 SuppressionFilter 。 我使用 Apache ant 通过持续集成进行自动构建。

我的问题来自以下情况：我不想在基于项目的目录中填充太多文件，因此 checkstyle.xml 和suppressions.xml 都位于名为conf 的子目录中（用于构建配置）。 现在，Ant 和 Eclipse 查找 Suppression.xml 的工作方式有所不同。

在我声明一个 ant 任务以使用 checkstyle 的基本配置查找 checkstyle.xml 后，Ant 使用基于项目的目录作为 basedir 来查找 Suppressions.xml。 此 checkstyle.xml 现在包含以下内容：

<module name="SuppressionFilter">
    <property name="file" value="conf/suppressions.xml"/>
</module>

这样 ant-build 就会找到 Suppressions.xml，因为构建的 basedir 是项目目录。

现在使用 Eclipse 的 checkstyle-plugin 会带来问题。 它从 checkstyle.xml 的路径 (conf) 开始查找 Suppressions.xml。 对于 Eclipse，声明必须如下所示才能工作：

<module name="SuppressionFilter">
    <property name="file" value="suppressions.xml"/>
</module>

编辑：即使这不起作用，Eclipse 似乎始终需要绝对路径。

我想知道一种方法，让 Eclipse 和 Ant 都可以使用相同的 checkstyle-configuration。 有人知道这个问题的解决方案吗？ 绝对路径不是解决方案，因为每个开发人员和 CI 服务器都有不同的项目目录路径。

Answer 1

很老了，但我找到了一种更好的方法来使用 Checkstyle 高级属性：

这个问题已经 在 Eclipse Checkstyle 插件中， ${samedir} 属性扩展到配置文件所在的目录：

在您的情况下，您的模块配置将如下所示：

<module name="SuppressionFilter">
    <property name="file" value="${samedir}/conf/suppressions.xml" />
</module>

Ant 目标还将设置 <代码>samedir 属性：

<checkstyle config="${checkstyle.tool.dir}/checks.xml" failOnViolation="false">
    <fileset dir="${src.dir}" includes="**/*.java" />
    <property key="samedir" value="${checkstyle.tool.dir}/conf" />
</checkstyle>

Answer 2

使用 Checkstyle 的属性扩展功能。 在 checkstyle.xml 中将 SupressionFilter 声明为：

<module name="SuppressionFilter">
    <property name="file" value="${checkstyle.suppressions.file}" default="suppressions.xml"/>
</module>

然后在 Ant 构建脚本中修改 Checkstyle 任务以包含嵌套属性：

<checkstyle config="conf/checkstyle.xml">
    <fileset dir="src" includes="**/*.java"/>
    <property key="checkstyle.suppressions.file" value="conf/suppressions.xml"/>
</checkstyle>