Configuration options for the PMD plugin.
Type | Name and description |
---|---|
boolean |
consoleOutput Whether or not to write PMD results to System.out . |
int |
rulePriority The rule priority threshold; violations for rules with a lower priority will not be reported. |
TextResource |
ruleSetConfig The custom rule set to be used (if any). |
FileCollection |
ruleSetFiles The custom rule set files to be used. |
List<String> |
ruleSets The built-in rule sets to be used. |
TargetJdk |
targetJdk The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp |
Constructor and description |
---|
PmdExtension
(Project project) |
Type | Name and description |
---|---|
void |
ruleSetFiles(Object... ruleSetFiles) Convenience method for adding rule set files. |
void |
ruleSets(String... ruleSets) Convenience method for adding rule sets. |
void |
setRulePriority(int intValue) Sets the rule priority threshold. |
void |
setTargetJdk(def value) Sets the target jdk used with pmd. |
Whether or not to write PMD results to System.out
.
The rule priority threshold; violations for rules with a lower priority will not be reported. Default value is 5, which means that all violations will be reported. This is equivalent to PMD's Ant task minimumPriority property.
See the official documentation for the list of priorities.
Example: rulePriority = 3 The custom rule set to be used (if any). Replaces ruleSetFiles
, except that
it does not currently support multiple rule sets.
See the
official documentation
for how to author a rule set.
Example: ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")
The custom rule set files to be used. See the official documentation for how to author a rule set file. Example: ruleSetFiles = files("config/pmd/myRuleSet.xml")
The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"]
The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp
Convenience method for adding rule set files. Example: ruleSetFiles "config/pmd/myRuleSet.xml"
ruleSetFiles
- the rule set files to be addedConvenience method for adding rule sets. Example: ruleSets "basic", "braces"
ruleSets
- the rule sets to be addedSets the rule priority threshold.
Sets the target jdk used with pmd.
Gradle API 2.8