| API Documentation: | PmdExtension |
|---|
Configuration options for the PMD plugin.
| Property | Description |
ignoreFailures | Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true |
reportsDir | The directory where reports will be generated. |
ruleSetFiles | 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") |
ruleSets | The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"] |
sourceSets | The source sets to be analyzed as part of the |
targetJdk | The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp |
toolVersion | The version of the code quality tool to be used. |
| Method | Description |
ruleSetFiles(ruleSetFiles) | Convenience method for adding rule set files. Example: ruleSetFiles "config/pmd/myRuleSet.xml" |
ruleSets(ruleSets) | Convenience method for adding rule sets. Example: ruleSets "basic", "braces" |
Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true
- Default:
false
File reportsDir
The directory where reports will be generated.
FileCollection ruleSetFiles
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")
- Default:
[]
The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"]
- Default:
["basic"]
Collection<SourceSet>sourceSets
Collection<SourceSet>The source sets to be analyzed as part of the check and build tasks.
- Default:
project.sourceSets
TargetJdk targetJdk
The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp
- Default:
project.sourceCompatibility
String toolVersion
The version of the code quality tool to be used.