Deprecated.
since 3.15.0 Use the goals pmd:aggregate-pmd and pmd:aggregate-cpd instead. See FAQ: Why do I get sometimes false positive and/or false negative violations? for an explanation.

Whether to build an aggregated report at the root, or build individual reports.

Enables the analysis cache, which speeds up PMD. This requires a cache file, that contains the results of the last PMD run. Thus the cache is only effective, if this file is not cleaned between runs.

The location of the analysis cache, if it is enabled. This file contains the results of the last PMD run and must not be cleaned between consecutive PMD runs. Otherwise the cache is not in use. If the file doesn't exist, PMD executes as if there is no cache enabled and all files are analyzed. Otherwise only changed files will be analyzed again.

Controls whether PMD will track benchmark information.

Benchmark output filename.

Specifies the location of the source directories to be used for PMD. Defaults to project.compileSourceRoots.

File that lists classes and rules to be excluded from failures. For PMD, this is a properties file. For CPD, this is a text file that contains comma-separated lists of classes that are allowed to duplicate.

The project source directories that should be excluded.

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.

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 produced in any case, since this format is needed for the check goals (pmd:check, pmd:aggregator-check, pmd:cpd-check, pmd:aggregator-cpd-check).

Run PMD on the tests as well.

Whether to include the XML files generated by PMD/CPD in the org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory().

A list of files to include from checking. Can contain Ant-style wildcards and double wildcards. Defaults to **\/*.java.

Allow for configuration of the jvm used to run PMD via maven toolchains. This permits a configuration where the project is built with one jvm and PMD is executed with another. This overrules the toolchain selected by the maven-toolchain-plugin.

Examples:

(see Guide to Toolchains for more info)

   <configuration>
       ...
       <jdkToolchain>
           <version>1.11</version>
       </jdkToolchain>
   </configuration>

   <configuration>
       ...
       <jdkToolchain>
           <version>1.8</version>
           <vendor>zulu</vendor>
       </jdkToolchain>
   </configuration>
   

note: requires at least Maven 3.3.1

The programming language to be analyzed by PMD. Valid values are currently java, javascript and jsp.

Link the violation line numbers to the (Test) Source XRef. Links will be created automatically if the JXR plugin is being used.

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)

The rule priority threshold; rules with lower priority than this will not be evaluated.

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

Also render processing errors into the HTML report. Processing errors are problems, that PMD encountered while executing the rules. It can be parsing errors or exceptions during rule execution. Processing errors indicate a bug in PMD and the information provided help in reporting and fixing bugs in PMD.

Also render the rule priority into the HTML report.

Add a section in the HTML report that lists the suppressed violations.

Add a section in the HTML report, that groups the found violations by rule priority in addition to grouping by file.

The PMD rulesets to use. See the Stock Java Rulesets for a list of available rules. Defaults to a custom ruleset provided by this maven plugin (/rulesets/java/maven-pmd-plugin-default.xml).

Before PMD is executed, the configured rulesets are resolved and copied into this directory.

Note: Before 3.13.0, this was by default ${project.build.directory}.

Deprecated.
With 3.22.0 and the upgrade to PMD 7, this parameter has no effect anymore. The PMD log is now always redirected into the maven log and this can't be disabled by this parameter anymore. In order to disable the logging, see Maven Logging. You'd need to start maven with MAVEN_OPTS=-Dorg.slf4j.simpleLogger.log.net.sourceforge.pmd=off mvn <goals>.

Redirect PMD log into maven log out. When enabled, the PMD log output is redirected to maven, so that it is visible in the console together with all the other log output. Also, if maven is started with the debug flag (-X or --debug), the PMD logger is also configured for debug.

Directory containing the site.xml file.

Skip the PMD report generation. Most useful on the command line via "-Dpmd.skip=true".

Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to false.

Note: the default value was changed from true to false with version 3.13.0.

per default pmd executions error are ignored to not break the whole

Source level marker used to indicate whether a RuleViolation should be suppressed. If it is not set, PMD's default will be used, which is NOPMD. See also PMD – Suppressing warnings.

The output directory for the intermediate XML report.

The target JDK to analyze based on. Should match the source used in the compiler plugin. Valid values depend on the used PMD version. Most common values are 8, 11, 17, and 21.

The full list of supported Java versions for each PMD version is available at Java support (PMD).

You can override the default PMD version by specifying PMD as a dependency, see Upgrading PMD at Runtime.

Note: this parameter is only used if the language parameter is set to java.

The directories containing the test-sources to be used for PMD. Defaults to project.testCompileSourceRoots

Controls whether the project's compile/test classpath should be passed to PMD to enable its type resolution feature.

Location where Source XRef is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /xref

Location where Test Source XRef is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /xref-test