Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html below:

pmd:cpd – Apache Maven PMD Plugin

This goal should be used as a Maven report.

Creates a report for PMD's Copy/Paste Detector (CPD) tool. It can also generate a cpd results file in any of these formats: xml, csv or txt.

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

• Type: boolean
• Since: 2.2
• Required: No
• User Property: aggregate
• Default: false

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

• Type: java.util.List<java.lang.String>
• Since: 3.7
• Required: No
• Default: ${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.

• Type: java.lang.String
• Since: 3.7
• Required: No
• User Property: pmd.excludeFromFailureFile

The project source directories that should be excluded.

• Type: java.io.File[]
• Since: 2.2
• Required: No

A list of files to exclude from checks. 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.

• Type: java.util.List<java.lang.String>
• Since: 2.2
• Required: No

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).

• Type: java.lang.String
• Required: No
• User Property: format
• Default: xml

If true, CPD ignores annotations.

• Type: boolean
• Since: 3.11.0
• Required: No
• User Property: cpd.ignoreAnnotations
• Default: false

Similar to ignoreLiterals but for identifiers; i.e., variable names, methods names, and so forth.

• Type: boolean
• Since: 2.5
• Required: No
• User Property: cpd.ignoreIdentifiers
• Default: false

If true, CPD ignores literal value differences when evaluating a duplicate block. This means that foo=42; and foo=43; will be seen as equivalent. You may want to run PMD with this option off to start with and then switch it on to see what it turns up.

• Type: boolean
• Since: 2.5
• Required: No
• User Property: cpd.ignoreLiterals
• Default: false

Run PMD on the tests as well.

• Type: boolean
• Since: 2.2
• Required: No
• Default: false

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

• Type: boolean
• Since: 3.0
• Required: No
• Default: false

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

• Type: java.util.List<java.lang.String>
• Since: 2.2
• Required: No

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

for more info)

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

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

requires at least Maven 3.3.1

• Type: java.util.Map<java.lang.String, java.lang.String>
• Since: 3.14.0
• Required: No

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

• Type: java.lang.String
• Since: 3.5
• Required: No
• Default: java

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

• Type: boolean
• Required: No
• User Property: linkXRef
• Default: true

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)

• Type: java.lang.String
• Required: No
• Default: default

The minimum number of tokens that need to be duplicated before it causes a violation.

• Type: int
• Required: No
• User Property: minimumTokens
• Default: 100

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

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().

• Type: java.io.File
• Required: Yes
• Default: ${project.build.directory}/reports

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

• Type: java.lang.String
• Required: No
• User Property: output.format

Timestamp for reproducible output archive entries, either formatted as ISO 8601

or as an int representing seconds since the epoch (like

).

• Type: java.lang.String
• Required: No
• Default: ${project.build.outputTimestamp}

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

. You'd need to start maven with

.

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.

• Type: boolean
• Since: 3.9.0
• Required: No
• User Property: pmd.showPmdLog
• Default: true

Directory containing the site.xml file.

• Type: java.io.File
• Required: No
• Default: ${basedir}/src/site

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

• Type: boolean
• Since: 2.1
• Required: No
• User Property: cpd.skip
• Default: false

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

.

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

• Type: boolean
• Since: 3.1
• Required: No
• Default: false

The output directory for the intermediate XML report.

• Type: java.io.File
• Required: Yes
• User Property: project.build.directory

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

• Type: java.util.List<java.lang.String>
• Since: 3.7
• Required: No
• Default: ${project.testCompileSourceRoots}

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

• Type: java.io.File
• Required: No

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

• Type: java.io.File
• Required: No

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4