检查样式:检查

全名

org.apache.maven.plugins:maven-checkstyle-plugin:2.7:check

说明

对上一次 Checkstyle 运行执行违规检查以查看是否存在任何违规。它读取 Checkstyle 输出文件,计算发现的违规数量并将其显示在控制台上。

属性

  • 需要执行一个 Maven 项目。
  • 需要对范围内的工件进行依赖解析:test
  • 目标是线程安全的并支持并行构建。
  • 默认绑定到生命周期阶段:verify

必需参数

姓名 类型 自从 描述
包括 细绳 - 指定要用于 Checkstyle 的源文件的名称过滤器。
默认值为**/*.java
源目录 文件 - 指定要用于 Checkstyle 的源目录的位置。
默认值为${project.build.sourceDirectory}

可选参数

姓名 类型 自从 描述
缓存文件 细绳 - 指定用于在连续运行中加速 Checkstyle 的缓存文件。
默认值为${project.build.directory}/checkstyle-cachefile
配置位置 细绳 2.5

指定要使用的 XML 配置的位置。

潜在值是文件系统路径、URL 或类路径资源。此参数期望位置的内容符合规则集的 xml 格式(Checkstyle Checker 模块)配置。

此参数被解析为资源、URL 和文件。如果成功解析,配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中,然后作为配置传递给 Checkstyle。

有 4 个预定义的规则集。

  • config/sun_checks.xml:Sun 检查。
  • config/turbine_checks.xml:涡轮检查。
  • config/avalon_checks.xml:阿瓦隆检查。
  • config/maven_checks.xml:Maven 源代码检查。

默认值为config/sun_checks.xml
控制台输出 布尔值 - 将错误输出到控制台。
默认值为false
编码 细绳 2.2 读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding,则使用平台默认编码。注意:此参数始终覆盖Checkstyle 的TreeWalker模块中的属性字符集。默认值为${project.build.sourceEncoding}
排除 细绳 - 指定要为 Checkstyle 排除的源文件的名称过滤器。
违规失败 布尔值 - 我们是否因违规而导致构建失败?
默认值为true
失败错误 布尔值 - 指定构建是否应因违规而失败。
默认值为false
标头位置 细绳 2.0-beta-2

指定 Checkstyle 可以使用的许可证文件(也称为头文件)的位置,以验证源代码是否具有正确的许可证头。

您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。

例如:

<module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module>


默认值为LICENSE.txt
包括TestSourceDirectory 布尔值 2.2 包含或不包含用于 Checkstyle 的测试源目录。
默认值为${false}
logViolationsToConsole 布尔值 2.3 将检测到的违规输出到控制台。
默认值为false
maxAllowedViolations 整数 2.3 允许的最大违规次数。仅当违规次数超过此限制时,执行才会失败。
默认值为0
输出文件 文件 - 指定保存 Checkstyle 输出的路径和文件名。输出文件的格式由 outputFileFormat参数确定。
默认值为${project.build.directory}/checkstyle-result.xml
输出文件格式 细绳 - 指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。
默认值为xml
属性位置 细绳 2.5

指定属性文件的位置。

这个参数被解析为 URL,文件然后资源。如果成功解析,属性位置的内容将被复制到 ${project.build.directory}/checkstyle-checker.properties 文件中,然后再传递给 Checkstyle 进行加载。

propertiesLocation的内容将提供给 Checkstyle 用于指定 xml 配置中的参数值(在configLocation 参数中指定)。


财产扩张 细绳 - 允许指定原始属性扩展信息。
跳过 布尔值 2.2 跳过整个检查。
默认值为false
跳过执行 布尔值 2.5 跳过检查类型执行只会扫描输出文件。
默认值为false
抑制文件表达式 细绳 2.1 要在抑制文件的属性中使用的键。
默认值为checkstyle.suppressions.file
抑制位置 细绳 2.0-beta-2

指定要使用的抑制 XML 文件的位置。

此参数被解析为资源、URL 和文件。如果成功解决,则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中,然后再传递给 Checkstyle 进行加载。

有关将可用于您的 checkstyle 配置的属性,请参阅suppresssFileExpression 。


测试源目录 文件 2.2 指定要用于 Checkstyle 的测试源目录的位置。
默认值为${project.build.testSourceDirectory}
使用文件 文件 - 如果为null,Checkstyle 插件将在标准输出上显示违规。否则,将创建一个包含违规的文本文件。
违规严重性 细绳 2.2 被视为违规的最低严重性级别。有效值为“错误”、“警告”和“信息”。
默认值为错误

参数详情

缓存文件

指定用于在连续运行中加速 Checkstyle 的缓存文件。
  • 类型java.lang.String
  • 要求
  • 默认值${project.build.directory}/checkstyle-cachefile

配置位置

指定要使用的 XML 配置的位置。

潜在值是文件系统路径、URL 或类路径资源。此参数期望位置的内容符合规则集的 xml 格式(Checkstyle Checker 模块)配置。

此参数被解析为资源、URL 和文件。如果成功解析,配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中,然后作为配置传递给 Checkstyle。

有 4 个预定义的规则集。

  • config/sun_checks.xml:Sun 检查。
  • config/turbine_checks.xml:涡轮检查。
  • config/avalon_checks.xml:阿瓦隆检查。
  • config/maven_checks.xml:Maven 源代码检查。
  • 类型java.lang.String
  • : 2.5
  • 要求
  • 表达式${checkstyle.config.location}
  • 默认值config/sun_checks.xml

控制台输出

将错误输出到控制台。
  • 类型布尔值
  • 要求
  • 默认值

编码

读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding,则使用平台默认编码。注意:此参数始终覆盖Checkstyle 的TreeWalker模块中的属性字符集。
  • 类型java.lang.String
  • : 2.2
  • 要求
  • 表达式${编码}
  • 默认值${project.build.sourceEncoding}

不包括

指定要为 Checkstyle 排除的源文件的名称过滤器。
  • 类型java.lang.String
  • 要求
  • 表达式${checkstyle.excludes}

失败违规

我们是否因违规而导致构建失败?
  • 类型布尔值
  • 要求
  • 表达式${checkstyle.failOnViolation}
  • 默认值

失败错误

指定构建是否应因违规而失败。
  • 类型布尔值
  • 要求
  • 默认值

标头位置

指定 Checkstyle 可以使用的许可证文件(也称为头文件)的位置,以验证源代码是否具有正确的许可证头。

您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。

例如:

<module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module>

  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${checkstyle.header.file}
  • 默认许可证.txt

包括TestSourceDirectory

包含或不包含用于 Checkstyle 的测试源目录。
  • 类型布尔值
  • : 2.2
  • 要求
  • 默认值${false}

包括

指定要用于 Checkstyle 的源文件的名称过滤器。
  • 类型java.lang.String
  • 要求
  • 表达式${checkstyle.includes}
  • 默认值**/*.java

logViolationsToConsole

将检测到的违规输出到控制台。
  • 类型布尔值
  • : 2.3
  • 要求
  • 表达式${checkstyle.console}
  • 默认值

最大允许违规

允许的最大违规次数。仅当违规次数超过此限制时,执行才会失败。
  • 类型整数
  • : 2.3
  • 要求
  • 表达式${checkstyle.maxAllowedViolations}
  • 默认值0

输出文件

指定保存 Checkstyle 输出的路径和文件名。输出文件的格式由 outputFileFormat参数确定。
  • 类型java.io.File
  • 要求
  • 表达式${checkstyle.output.file}
  • 默认值${project.build.directory}/checkstyle-result.xml

输出文件格式

指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。
  • 类型java.lang.String
  • 要求
  • 表达式${checkstyle.output.format}
  • 默认值xml

属性位置

指定属性文件的位置。

这个参数被解析为 URL,文件然后资源。如果成功解析,属性位置的内容将被复制到 ${project.build.directory}/checkstyle-checker.properties 文件中,然后再传递给 Checkstyle 进行加载。

propertiesLocation的内容将提供给 Checkstyle 用于指定 xml 配置中的参数值(在configLocation 参数中指定)。

  • 类型java.lang.String
  • : 2.5
  • 要求
  • 表达式${checkstyle.properties.location}

属性扩展

允许指定原始属性扩展信息。
  • 类型java.lang.String
  • 要求

跳过

跳过整个检查。
  • 类型布尔值
  • : 2.2
  • 要求
  • 表达式${checkstyle.skip}
  • 默认值

跳过执行

跳过检查类型执行只会扫描输出文件。
  • 类型布尔值
  • : 2.5
  • 要求
  • 表达式${checkstyle.skipExec}
  • 默认值

源目录

指定要用于 Checkstyle 的源目录的位置。
  • 类型java.io.File
  • 要求
  • 默认值${project.build.sourceDirectory}

抑制文件表达式

要在抑制文件的属性中使用的键。
  • 类型java.lang.String
  • : 2.1
  • 要求
  • 表达式${checkstyle.suppression.expression}
  • 默认checkstyle.suppressions.file

抑制位置

指定要使用的抑制 XML 文件的位置。

此参数被解析为资源、URL 和文件。如果成功解决,则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中,然后再传递给 Checkstyle 进行加载。

有关将可用于您的 checkstyle 配置的属性,请参阅suppresssFileExpression 。

  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${checkstyle.suppressions.location}

测试源目录

指定要用于 Checkstyle 的测试源目录的位置。
  • 类型java.io.File
  • : 2.2
  • 要求
  • 默认值${project.build.testSourceDirectory}

使用文件

如果为null,Checkstyle 插件将在标准输出上显示违规。否则,将创建一个包含违规的文本文件。
  • 类型java.io.File
  • 要求

违规严重性

被视为违规的最低严重性级别。有效值为“错误”、“警告”和“信息”。
  • 类型java.lang.String
  • : 2.2
  • 要求
  • 表达式${checkstyle.violationSeverity}
  • 默认值错误