| API Documentation: | Pmd |
|---|
Runs a set of static code analysis rules on Java source code files and generates a report of problems found.
| Property | Description |
classpath | Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves. This is only well supported for PMD 5.2.1 or better. |
consoleOutput | Whether or not to write PMD results to |
excludes | The set of exclude patterns. |
ignoreFailures | Whether or not to allow the build to continue if there are warnings. |
includes | The set of include patterns. |
pmdClasspath | The class path containing the PMD library to be used. |
reports | The reports to be generated by this task. |
rulePriority | Specifies the rule priority threshold. |
ruleSetConfig | The custom rule set to be used (if any). Replaces |
ruleSetFiles | The custom rule set files to be used. See the official documentation for how to author a rule set file.
If you want to only use custom rule sets, you must clear |
ruleSets | The built-in rule sets to be used. See the official list of built-in rule sets. |
source | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist. |
targetJdk | The target JDK to use with PMD. |
| Method | Description |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
|
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
|
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included. |
reports(configureAction) | Configures the reports to be generated by this task. |
source(sources) | Adds some source to this task. The given source objects will be evaluated as per |
| Block | Description |
reports | Configures the reports to be generated by this task. |
FileCollection classpath
Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves. This is only well supported for PMD 5.2.1 or better.
- Default with
pmdplugin: -
sourceSet.outputsourceSet.compileClasspath
Whether or not to write PMD results to System.out.
- Default with
pmdplugin: project.pmd.consoleOutput
Whether or not to allow the build to continue if there are warnings.
ignoreFailures = true
- Default with
pmdplugin: project.pmd.ignoreFailures
FileCollection pmdClasspath
The class path containing the PMD library to be used.
- Default with
pmdplugin: project.configurations.pmd
PmdReports reports (read-only)
The reports to be generated by this task.
Specifies the rule priority threshold.
- Default with
pmdplugin: project.pmd.rulePriority
TextResource ruleSetConfig
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.
ruleSetConfig = resources.text.fromFile(resources.file("config/pmd/myRuleSets.xml"))
- Default with
pmdplugin: project.pmd.ruleSetConfig
FileCollection ruleSetFiles
The custom rule set files to be used. See the official documentation for how to author a rule set file.
If you want to only use custom rule sets, you must clear ruleSets.
ruleSetFiles = files("config/pmd/myRuleSet.xml")
- Default with
pmdplugin: project.pmd.ruleSetFiles
The built-in rule sets to be used. See the official list of built-in rule sets.
ruleSets = ["basic", "braces"]
- Default with
pmdplugin: project.pmd.ruleSets
FileTree source (read-only)
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE.
If your sources are less strict, please change it accordingly by overriding this method in your subclass.
- Default with
pmdplugin: sourceSet.allJava
SourceTask exclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
FileTreeElement as its parameter. The closure should return true or false. Example:
copySpec {
from 'source'
into 'destination'
//an example of excluding files from certain configuration:
exclude { it.file in configurations.someConf.files }
}
If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask include(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
FileTreeElement as its parameter.
If includes are not provided, then all files in this container will be included. If includes are provided, then a
file must match at least one of the include patterns or specs to be included.
SourceTask include(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
SourceTask include(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
PmdReports reports(Action<? super PmdReports>
Action<? super PmdReports>Configures the reports to be generated by this task.
SourceTask source(Object...
Object...Adds some source to this task. The given source objects will be evaluated as per Project.files(java.lang.Object[]).