| API 文档 | PmdExtension |
|---|
PMD 插件的配置选项。
| 属性 | 描述 |
consoleOutput | 是否将 PMD 结果写入 |
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 | 要使用的自定义规则集文件。有关如何编写规则集文件，请参见官方文档。 |
ruleSets | 要使用的内置规则集。参见内置规则集的官方列表。如果未明确配置，则返回的惯例值是 "category/java/errorprone.xml"，除非 |
rulesMinimumPriority | 规则优先级阈值；优先级较低的规则违规将不会报告。默认值为 5，这意味着将报告所有违规。这等同于 PMD Ant 任务的 minimumPriority 属性。有关优先级的列表，请参见官方文档。 |
sourceSets | 作为 |
targetJdk | 与 PMD 一起使用的目标 JDK，可以是 1.3、1.4、1.5、1.6、1.7 或 jsp |
threads | PMD 使用的线程数。 |
toolVersion | 要使用的代码质量工具版本。 |
| 方法 | 描述 |
ruleSetFiles(ruleSetFiles) | 用于添加规则集文件的便捷方法。 |
ruleSets(ruleSets) | 用于添加规则集的便捷方法。 |
控制是否使用增量分析。此功能仅在 PMD 6.0.0 或更高版本中支持。更多详情请参见 https://docs.pmd-code.org/pmd-doc-6.55.0/pmd_userdocs_incremental_analysis.html。
- 默认值
false
File reportsDir
将生成报告的目录。
TextResource ruleSetConfig
要使用的自定义规则集（如果有）。它取代了 ruleSetFiles，但目前不支持多个规则集。有关如何编写规则集，请参见官方文档。
ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")
- 默认值
null
FileCollection ruleSetFiles
要使用的自定义规则集文件。有关如何编写规则集文件，请参见官方文档。
ruleSetFiles = files("config/pmd/myRuleSet.xml")
- 默认值
[]
要使用的内置规则集。参见内置规则集的官方列表。如果未明确配置，则返回的惯例值是 "category/java/errorprone.xml"，除非 PmdExtension.getRuleSetConfig() 返回非 null 值，或者 PmdExtension.getRuleSetFiles() 的返回值非空，在这种情况下，惯例值为空列表
ruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]
- 默认值
["category/java/errorprone.xml"]
规则优先级阈值；优先级较低的规则违规将不会报告。默认值为 5，这意味着将报告所有违规。这等同于 PMD Ant 任务的 minimumPriority 属性。有关优先级的列表，请参见官方文档。
rulesMinimumPriority = 3
- 默认值
5
String toolVersion
要使用的代码质量工具版本。