| 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() 傳回非空值，或 PmdExtension.getRuleSetFiles() 的傳回值為非空，在這種情況下，慣例值為空列表
ruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]
- 預設
["category/java/errorprone.xml"]
規則優先級閾值；將不會報告優先級較低的規則的違規。預設值為 5，表示將報告所有違規。這相當於 PMD Ant 任務的 minimumPriority 屬性。請參閱 優先級列表 的官方文件。
rulesMinimumPriority = 3
- 預設
5
String toolVersion
要使用的程式碼品質工具版本。