检查风格 + 抑制滤波器

Question

我有一个 checkstyle 抑制过滤器设置（例如忽略单元测试代码中的幻数）。

抑制 xml 文件与 checkstyle xml 文件位于同一文件夹中。 但是，该文件的实际位置有所不同： 在我的 Windows 开发盒上，它位于 d:\dev\shared\checkstyle\config 在 Linux CI 服务器上，它将位于 /root/repo/shared/checkstyle/config 在另一个开发人员盒子上，它可以在任何地方（他们查看他们的 svn 存储库）。

唯一“一致”的是抑制文件始终与 checkstyle xml 文件位于同一文件夹中。 我无法弄清楚如何确保始终一致地拾取该文件。 另外我不知道为什么 checkstyle 不支持 checkstyle xml 文件中的嵌入抑制。

有什么帮助吗？

Answer 1

当我在 Linux 和 Windows 之间来回切换时，Checkstyle 抑制配置也遇到了同样的问题。 以下是我在基于 Ant 的构建系统中解决该问题的方法：

基本上，我通过使用 Ant 构建脚本配置 Checkstyle 属性文件，将正确的、特定于平台的目录值注入到主 Checkstyle 配置文件中。

我的主 Checkstyle 配置文件有一个 SuppressionFilter 模块声明，如下所示。 checkstyle-suppressions-file 属性的值来自 Checkstyle 属性文件：

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

Checkstyle 属性文件不是静态的，它是由 Ant 构建脚本从名为 template 的属性文件模板生成的-checkstyle.properties。 抑制文件属性的模板如下所示：

checkstyle-suppressions-file=@SCM_DIR@/checkstyle_suppressions.xml

我的 Ant 构建脚本将此文件复制到名为 checkstyle.properties 的文件中。 该副本将特殊标记替换为找到抑制文件的目录的正确值：

<copy file="${scm.dir}/template-checkstyle.properties" tofile="${scm.dir}/checkstyle.properties">
    <filterset>
        <filter token="SCM_DIR" value="${scm.dir.unix}"/>
    </filterset>
</copy>

现在，scm.dir.unix 的值从何而来？ 好吧，它派生自我的构建的属性，请继续阅读。 您需要使用您提到的目录值来指定这样的值。

请注意，关于指定此目录的方式，有一个不太明显的问题。 我说 scm.dir.unix 值是从构建属性派生的，因为我观察到主 Checkstyle 配置文件在 的值中不能包含反斜杠，即 Windows 路径分隔符字符。 SuppressionFilter 模块的 file 属性。 例如，指定类似 C:\foo\bar\baz 的内容会导致出现 Checkstyle 错误消息，指出无法找到 C:foobarbaz。 我通过使用 Ant 的 pathconvert 任务将 scm.dir 目录构建属性“转换”为“unix”格式来解决此问题：

<pathconvert targetos="unix" property="scm.dir.unix">
    <path location="${scm.dir}"/>
</pathconvert>

然后我调用 checkstyle Ant 任务如下：

<checkstyle config="${scm.dir}/checkstyle_checks.xml"
            properties="${scm.dir}/checkstyle.properties">
    <!-- details elided -->
</checkstyle>

对 checkstyle 任务的调用会将 checkstyle.properties 文件中包含的键/值对注入到主 Checkstyle 配置中。

如果您愿意，您可以在此处查看完整脚本

希望这会有所帮助

Answer 2

在 Eclipse 中，我添加了以下内容，不需要我添加任何其他属性：

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

Answer 3

我使用 ant.file 变量和项目名称获取 build.xml 所在目录的绝对路径：

<project name="common" ... >
  <dirname property="thisdir" file="${ant.file.common}"/>

然后我可以将绝对路径连接到我的 checkstyle配置文件：

checkstyle.suppressions.file=${thisdir}/qclib/checkstyle-suppressions.xml

由于 thisdir 变量来自 ant，因此它似乎不需要路径分隔符转换。

Answer 4

如果您正在使用 Eclipse，并且抑制文件与外部 checkstyle 配置位于同一目录中，则可以像这样设置抑制过滤器：

<module name="SuppressionFilter">
    <property name="file" value="${config_dir}/my_suppressions.xml"/>
</module>

您还必须在 checkstyle 配置中定义 ${config_dir} 属性：

Eclipse Preferences - > “检查风格”-> 选择您的 cs 配置 -> “属性..”-> “附加属性..”

为 checkstyle 配置目录定义一个属性：

config_dir --->  ${config_loc}

Answer 5

我认为 Robert 的答案可以扩展到 ant 和 Eclipse 的简单解决方案：

将抑制文件包含在您的配置 XML 中，如下所示：

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

现在，Eclipse 满意并找到了该文件。

为了让 ant 工作，请将您的目标更新为如下所示：

<checkstyle config="${checkstyle.config}/checkstyle-checks.xml">
    <!-- ... -->
    <property key="samedir" value="${checkstyle.config}"/>
</checkstyle>

希望这会有所帮助。

Answer 6

从 CheckStyle 4.26.0 开始，您可以在配置文件中使用预定义常量。

(https://github.com/jshiell/checkstyle-idea/issues/217）：

• ${basedir} & ${project_loc} - 映射到当前项目目录
• ${workspace_loc} - 映射到当前 Eclipse 工作空间目录
• ${config_loc} & ${samedir} - 映射到配置文件所在的目录

如果您想与 maven 共享配置，您将需要使用“propertyExpansion”在 POM 配置（在报告部分）中“别名”“eclipse 常量” ”配置元素：

<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-checkstyle-plugin</artifactId>
   <version>3.0.0</version>
   <configuration>
      <configLocation>${project.basedir}/quality/checkstyle/dap_checkstyle_checks.xml</configLocation>
      <propertyExpansion>basedir=${project.basedir}</propertyExpansion>
   </configuration>
   <reportSets>
      <reportSet>
         <reports>
            <report>checkstyle</report>
         </reports>
      </reportSet>
   </reportSets>
</plugin>

“propertyExpansion”的灵感来自：https:// github.com/checkstyle/checkstyle/blob/master/pom.xml#L582。