检查样式:检查

全名

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

说明

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

属性

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

可选参数

姓名 类型 自从 描述
违规失败 boolean - 我们是否因违规而导致构建失败?默认值为:true
输出文件 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

输出文件

指定保存 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