下午:检查

全名:

org.apache.maven.plugins:maven-pmd-plugin:3.16.0:check

说明:

如果源代码中存在任何 PMD 违规,则构建失败。

属性:

  • 需要执行一个 Maven 项目。
  • 自版本:2.0。
  • 默认绑定到生命周期阶段:验证。
  • 在执行自身之前调用此插件的目标pmd的执行。

必需参数

姓名 类型 自从 描述
<failOnViolation> 布尔值 2.0 如果验证检查失败,是否使构建失败。属性failurePriority和 maxAllowedViolations控制在什么条件下构建应该失败。
默认值为:true。
用户属性是:pmd.failOnViolation。
<故障优先级> 整数 2.0 构建失败的优先级。根据规则的优先级,为 PMD 违规分配从 1(最严重)到 5(最不严重)的优先级。低于或低于此优先级的违规被视为失败,如果 failOnViolation=true并且计数超过 maxAllowedViolations ,则构建将失败。其他违规将被视为警告,如果 verbose=true将显示在构建输出中。将值设置为 5 会将所有违规视为失败,这可能会导致构建失败。将值设置为 1 会将所有违规行为视为警告。只有从 1 到 5 的值是有效的。
默认值为:5。
用户属性是:pmd.failurePriority.
<目标目录> 文件 2.0 要检查的 XML 报告的位置,由 PMD 报告生成。
用户属性是:project.build.directory。

可选参数

姓名 类型 自从 描述
<聚合> 布尔值 2.2 已弃用。从 3.15.0 开始使用目标pmd:aggregate-check或 pmd:aggregate-cpd-check代替。
默认值为:false。
用户属性是:聚合。
<excludeFromFailureFile> 细绳 3.0 列出要从失败中排除的类和规则的文件。对于 PMD,这是一个属性文件。对于 CPD,这是一个文本文件,其中包含允许复制的类的逗号分隔列表。
用户属性是:pmd.excludeFromFailureFile。
<maxAllowedViolations> 整数 3.10.0 执行失败前允许的最大失败次数。与failOnViolation=true结合使用并利用 failurePriority。如果failOnViolation=false ,该值没有意义 。如果失败次数大于此数量,则构建将失败。如果失败次数小于或等于该值,则构建不会失败。
默认值为:0。
用户属性是:pmd.maxAllowedViolations。
<printFailingErrors> 布尔值 3.0 打印导致构建失败的错误的详细信息
默认值为:false。
用户属性是:pmd.printFailingErrors。
<跳过> 布尔值 2.0 跳过 PMD 检查。通过“-Dpmd.skip=true”在命令行上最有用。
默认值为:false。
用户属性是:pmd.skip。
<详细> 布尔值 2.0 打印检查失败的详细信息以构建输出。
默认值为:false。
用户属性是:pmd.verbose。

参数详情

<聚合>

已弃用。从 3.15.0 开始使用目标pmd:aggregate-check或 pmd:aggregate-cpd-check代替。
是在根目录构建聚合报告,还是构建单独的报告。
  • 类型:布尔值
  • 从: 2.2
  • 要求:否
  • 用户属性:聚合
  • 默认值:假

<excludeFromFailureFile>

列出要从失败中排除的类和规则的文件。对于 PMD,这是一个属性文件。对于 CPD,这是一个文本文件,其中包含允许复制的类的逗号分隔列表。
  • 类型:java.lang.String
  • 从: 3.0
  • 要求:否
  • 用户属性:pmd.excludeFromFailureFile

<failOnViolation>

如果验证检查失败,是否使构建失败。属性failurePriority和 maxAllowedViolations控制在什么条件下构建应该失败。
  • 类型:布尔值
  • 从: 2.0
  • 要求:是
  • 用户属性:pmd.failOnViolation
  • 默认值:真

<故障优先级>

构建失败的优先级。根据规则的优先级,为 PMD 违规分配从 1(最严重)到 5(最不严重)的优先级。低于或低于此优先级的违规被视为失败,如果 failOnViolation=true并且计数超过 maxAllowedViolations ,则构建将失败。其他违规将被视为警告,如果 verbose=true将显示在构建输出中。将值设置为 5 会将所有违规视为失败,这可能会导致构建失败。将值设置为 1 会将所有违规行为视为警告。只有从 1 到 5 的值是有效的。
  • 类型:整数
  • 从: 2.0
  • 要求:是
  • 用户属性:pmd.failurePriority
  • 默认值:5

<maxAllowedViolations>

执行失败前允许的最大失败次数。与failOnViolation=true结合使用并利用 failurePriority。如果failOnViolation=false ,该值没有意义 。如果失败次数大于此数量,则构建将失败。如果失败次数小于或等于该值,则构建不会失败。
  • 类型:整数
  • 自:3.10.0
  • 要求:否
  • 用户属性:pmd.maxAllowedViolations
  • 默认值:0

<printFailingErrors>

打印导致构建失败的错误详细信息
  • 类型:布尔值
  • 从: 3.0
  • 要求:否
  • 用户属性:pmd.printFailingErrors
  • 默认值:假

<跳过>

跳过 PMD 检查。通过“-Dpmd.skip=true”在命令行上最有用。
  • 类型:布尔值
  • 从: 2.0
  • 要求:否
  • 用户属性:pmd.skip
  • 默认值:假

<目标目录>

要检查的 XML 报告的位置,由 PMD 报告生成。
  • 类型:java.io.File
  • 从: 2.0
  • 要求:是
  • 用户属性:project.build.directory

<详细>

打印检查失败的详细信息以构建输出。
  • 类型:布尔值
  • 从: 2.0
  • 要求:否
  • 用户属性:pmd.verbose
  • 默认值:假