PmdExtension

API 文档PmdExtension

PMD 插件的配置选项。

属性

属性描述
consoleOutput

是否将 PMD 结果写入 System.out

ignoreFailures

是否允许在存在警告时继续构建。示例:ignoreFailures = true

incrementalAnalysis

控制是否使用增量分析。这仅在 PMD 6.0.0 或更高版本中受支持。有关更多详细信息,请参阅 https://docs.pmd-code.org/pmd-doc-6.55.0/pmd_userdocs_incremental_analysis.html

maxFailures

在停止构建之前允许的最大失败次数。如果

reportsDir

将在其中生成报告的目录。

ruleSetConfig

要使用的自定义规则集(如果有)。替换 ruleSetFiles,但目前不支持多个规则集。有关如何编写规则集,请参阅 官方文档

ruleSetFiles

要使用的自定义规则集文件。有关如何编写规则集文件,请参阅 官方文档

ruleSets

要使用的内置规则集。请参阅内置规则集的官方列表。如果未显式配置,则返回的常规值为 "category/java/errorprone.xml",除非 PmdExtension.getRuleSetConfig() 返回非空值,或者 PmdExtension.getRuleSetFiles() 的返回值非空,在这种情况下,常规值为空列表

rulesMinimumPriority

规则优先级阈值;将不会报告优先级较低的规则的违规。默认值为 5,这意味着将报告所有违规。这等效于 PMD 的 Ant 任务 minimumPriority 属性。有关优先级列表,请参阅官方文档。

sourceSets

要作为 checkbuild 任务一部分进行分析的源集。

targetJdk

要与 pmd 一起使用的目标 jdk,1.3、1.4、1.5、1.6、1.7 或 jsp

threads

PMD 使用的线程数。

toolVersion

要使用的代码质量工具的版本。

方法

方法描述
ruleSetFiles(ruleSetFiles)

用于添加规则集文件的便捷方法。

ruleSets(ruleSets)

用于添加规则集的便捷方法。

脚本块

没有脚本块

属性详情

boolean consoleOutput

是否将 PMD 结果写入 System.out

默认值
false

boolean ignoreFailures

是否允许在存在警告时继续构建。示例:ignoreFailures = true

Property<Boolean> incrementalAnalysis

控制是否使用增量分析。这仅在 PMD 6.0.0 或更高版本中受支持。有关更多详细信息,请参阅 https://docs.pmd-code.org/pmd-doc-6.55.0/pmd_userdocs_incremental_analysis.html

默认值
false

Property<Integer> maxFailures

在停止构建之前允许的最大失败次数。如果

ignoreFailures

如果设置,则忽略此项,并且不强制限制。

默认值
0

File reportsDir

将在其中生成报告的目录。

TextResource ruleSetConfig

要使用的自定义规则集(如果有)。替换 ruleSetFiles,但目前不支持多个规则集。有关如何编写规则集,请参阅 官方文档

    ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")
默认值
null

FileCollection ruleSetFiles

要使用的自定义规则集文件。有关如何编写规则集文件,请参阅 官方文档

    ruleSetFiles = files("config/pmd/myRuleSet.xml")
默认值
[]

List<String> ruleSets

要使用的内置规则集。请参阅内置规则集的官方列表。如果未显式配置,则返回的常规值为 "category/java/errorprone.xml",除非 PmdExtension.getRuleSetConfig() 返回非空值,或者 PmdExtension.getRuleSetFiles() 的返回值非空,在这种情况下,常规值为空列表

    ruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]
默认值
["category/java/errorprone.xml"]

Property<Integer> rulesMinimumPriority

规则优先级阈值;将不会报告优先级较低的规则的违规。默认值为 5,这意味着将报告所有违规。这等效于 PMD 的 Ant 任务 minimumPriority 属性。有关优先级列表,请参阅官方文档。

    rulesMinimumPriority = 3
默认值
5

Collection<SourceSet> sourceSets

要作为 checkbuild 任务一部分进行分析的源集。

默认值
project.sourceSets

TargetJdk targetJdk

要与 pmd 一起使用的目标 jdk,1.3、1.4、1.5、1.6、1.7 或 jsp

默认值
project.sourceCompatibility

Property<Integer> threads

PMD 使用的线程数。

默认值
1

String toolVersion

要使用的代码质量工具的版本。

方法详情

void ruleSetFiles(Object... ruleSetFiles)

用于添加规则集文件的便捷方法。

    ruleSetFiles "config/pmd/myRuleSet.xml"

void ruleSets(String... ruleSets)

用于添加规则集的便捷方法。

    ruleSets "category/java/errorprone.xml", "category/java/bestpractices.xml"