Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-pmd-plugin:3.0.1:pmd
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| outputDirectory | File | 2.0 | The output directory for the final HTML report. Note that this
parameter is only evaluated if the goal is run directly from the
command line or during the default lifecycle. If the goal is run
indirectly as part of a site generation, the output directory
configured in the Maven Site Plugin is used instead. User property is: project.reporting.outputDirectory. |
| targetDirectory | File | 2.0 | The output directory for the intermediate XML report. User property is: project.build.directory. |
| Name | Type | Since | Description |
|---|---|---|---|
| aggregate | boolean | 2.2 | Whether to build an aggregated report at the root, or build
individual reports. Default value is: false. User property is: aggregate. |
| excludeRoots | File[] | 2.2 | The project source directories that should be excluded. |
| excludes | List | 2.2 | A list of files to exclude from checking. Can contain Ant-style
wildcards and double wildcards. Note that these exclusion patterns
only operate on the path of a source file relative to its source
root directory. In other words, files are excluded based on their
package and/or class name. If you want to exclude entire source
root directories, use the parameter excludeRoots
instead. |
| format | String | 2.0 | Set the output format type, in addition to the HTML report. Must be
one of: "none", "csv", "xml", "txt" or the full class name of the
PMD renderer to use. See the net.sourceforge.pmd.renderers package
javadoc for available renderers. XML is required if the pmd:check
goal is being used. Default value is: xml. User property is: format. |
| includeTests | boolean | 2.2 | Run PMD on the tests. Default value is: false. |
| includeXmlInSite | boolean | 3.0 | Whether to include the xml files generated by PMD/CPD in the
site. Note: In versions 2.2 - 2.7.1 the default value for this was true. This was changed in version 3.0. Default value is: false. |
| includes | List | 2.2 | A list of files to include from checking. Can contain Ant-style
wildcards and double wildcards. Defaults to **\/*.java. |
| language | String | 3.0 | The programming language to be analyzed by PMD. Valid values are
currently java and ecmascript or
javascript.
Note: if the parameter targetJdk is given, then this language parameter will be ignored. Default value is: java. |
| linkXRef | boolean | 2.0 | Link the violation line numbers to the source xref. Links will be
created automatically if the jxr plugin is being used. Default value is: true. User property is: linkXRef. |
| minimumPriority | int | 2.1 | The rule priority threshold; rules with lower priority than this
will not be evaluated. Default value is: 5. User property is: minimumPriority. |
| outputEncoding | String | 2.5 | The file encoding when writing non-HTML reports. Default value is: ${project.reporting.outputEncoding}. User property is: outputEncoding. |
| rulesets | String[] | 2.0 | The PMD rulesets to use. See the Stock
Rulesets for a list of some included. Since version 2.5, the
ruleset "rulesets/maven.xml" is also available. Defaults to the
java-basic, java-imports and java-unusedcode rulesets. |
| skip | boolean | 2.1 | Skip the PMD report generation. Most useful on the command line via
"-Dpmd.skip=true". Default value is: false. User property is: pmd.skip. |
| sourceEncoding | String | 2.3 | The file encoding to use when reading the Java sources. Default value is: ${project.build.sourceEncoding}. User property is: encoding. |
| targetJdk | String | 2.0 | The target JDK to analyze based on. Should match the target used in
the compiler plugin. Valid values are currently 1.3,
1.4, 1.5, 1.6 and
1.7. Note: support for 1.6 was
added in version 2.3 of this plugin, support for 1.7
was added in version 2.7 of this plugin. User property is: targetJdk. |
| typeResolution | boolean | 3.0 | Controls whether the project's compile/test classpath should be
passed to PMD to enable its type resolution feature. Default value is: false. User property is: pmd.typeResolution. |
| xrefLocation | File | 2.0 | Location of the Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref. |
| xrefTestLocation | File | 2.0 | Location of the Test Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref-test. |
Note: if the parameter targetJdk is given, then this language parameter will be ignored.
skip: