检查样式：检查

全名：

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

说明：

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

属性：

  • 需要执行 Maven 2.0 项目。
  • 需要范围内工件的依赖关系解析：compile.
  • 默认绑定到生命周期阶段：verify.
  • checkstyle在执行自身之前调用此插件目标的执行。

可选参数

姓名 类型 自从 描述
违规失败 boolean - 我们是否因违规而导致构建失败？
默认值为：true。
logViolationsToConsole boolean 2.3 将检测到的违规输出到控制台。
默认值为：false。
maxAllowedViolations int 2.3 允许的最大违规次数。仅当违规次数超过此限制时，执行才会失败。
默认值为：0。
输出文件 File - 指定保存 Checkstyle 输出的路径和文件名。输出文件的格式由 outputFileFormat参数决定。
默认值为：${project.build.directory}/checkstyle-result.xml。
输出文件格式 String - 指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。
默认值为：xml。
跳过 boolean 2.2 跳过整个检查。
默认值为：false。
违规严重性 String 2.2 被视为违规的最低严重性级别。有效值为“错误”、“警告”和“信息”。
默认值为：error。

参数详情

失败违规：

我们是否因违规而导致构建失败？
  • 类型：boolean
  • 必需：No
  • 表达式：${checkstyle.failOnViolation}
  • 默认：true

logViolationsToConsole：

将检测到的违规输出到控制台。
  • 类型：boolean
  • 自：2.3
  • 必需：No
  • 表达式：${checkstyle.console}
  • 默认：false

最大允许违规：

允许的最大违规次数。仅当违规次数超过此限制时，执行才会失败。
  • 类型：int
  • 自：2.3
  • 必需：No
  • 表达式：${checkstyle.maxAllowedViolations}
  • 默认：0

输出文件：

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

输出文件格式：

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

跳过：

跳过整个检查。
  • 类型：boolean
  • 自：2.2
  • 必需：No
  • 表达式：${checkstyle.skip}
  • 默认：false

违规严重性：

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