pmd:check
Full name:
org.apache.maven.plugins:maven-pmd-plugin:3.18.0:check
Description:
Fails the build if there were any PMD violations in the source
code.
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Since version:
2.0
. - Binds by default to the lifecycle phase:
verify
. - Invokes the execution of this plugin's goal
pmd
prior to executing itself.
Required Parameters
Name | Type | Since | Description |
---|---|---|---|
<failOnViolation> |
boolean |
2.0 |
Whether to fail the build if the validation check fails. The
properties failurePriority and
maxAllowedViolations control under which conditions
exactly the build should be failed.Default value is: true .User property is: pmd.failOnViolation . |
<failurePriority> |
int |
2.0 |
What priority level to fail the build on. PMD violations are
assigned a priority from 1 (most severe) to 5 (least severe)
according the the rule's priority. Violations at or less than this
priority level are considered failures and will fail the build if
failOnViolation=true and the count exceeds
maxAllowedViolations . The other violations will be
regarded as warnings and will be displayed in the build output if
verbose=true . Setting a value of 5 will treat all
violations as failures, which may cause the build to fail. Setting
a value of 1 will treat all violations as warnings. Only values
from 1 to 5 are valid.Default value is: 5 .User property is: pmd.failurePriority . |
<targetDirectory> |
File |
2.0 |
The location of the XML report to check, as generated by the PMD
report. User property is: project.build.directory . |
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<aggregate> |
boolean |
2.2 |
Deprecated. since 3.15.0 Use the goal pmd:aggregate-check or
pmd:aggregate-cpd-check instead.Default value is: false .User property is: aggregate . |
<excludeFromFailureFile> |
String |
3.0 |
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. User property is: pmd.excludeFromFailureFile . |
<maxAllowedViolations> |
int |
3.10.0 |
The maximum number of failures allowed before execution fails. Used
in conjunction with failOnViolation=true and utilizes
failurePriority . This value has no meaning if
failOnViolation=false . If the number of failures is
greater than this number, the build will be failed. If the number
of failures is less than or equal to this value, then the build
will not be failed.Default value is: 0 .User property is: pmd.maxAllowedViolations . |
<printFailingErrors> |
boolean |
3.0 |
Print details of errors that cause build failure Default value is: false .User property is: pmd.printFailingErrors . |
<skip> |
boolean |
2.0 |
Skip the PMD checks. Most useful on the command line via
"-Dpmd.skip=true". Default value is: false .User property is: pmd.skip . |
<verbose> |
boolean |
2.0 |
Print details of check failures to build output. Default value is: false .User property is: pmd.verbose . |
Parameter Details
<aggregate>
Deprecated. since 3.15.0 Use the goal
pmd:aggregate-check
or
pmd:aggregate-cpd-check
instead.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
<excludeFromFailureFile>
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.0
- Required:
No
- User Property:
pmd.excludeFromFailureFile
<failOnViolation>
Whether to fail the build if the validation check fails. The
properties
failurePriority
and
maxAllowedViolations
control under which conditions
exactly the build should be failed.- Type:
boolean
- Since:
2.0
- Required:
Yes
- User Property:
pmd.failOnViolation
- Default:
true
<failurePriority>
What priority level to fail the build on. PMD violations are
assigned a priority from 1 (most severe) to 5 (least severe)
according the the rule's priority. Violations at or less than this
priority level are considered failures and will fail the build if
failOnViolation=true
and the count exceeds
maxAllowedViolations
. The other violations will be
regarded as warnings and will be displayed in the build output if
verbose=true
. Setting a value of 5 will treat all
violations as failures, which may cause the build to fail. Setting
a value of 1 will treat all violations as warnings. Only values
from 1 to 5 are valid.- Type:
int
- Since:
2.0
- Required:
Yes
- User Property:
pmd.failurePriority
- Default:
5
<maxAllowedViolations>
The maximum number of failures allowed before execution fails. Used
in conjunction with
failOnViolation=true
and utilizes
failurePriority
. This value has no meaning if
failOnViolation=false
. If the number of failures is
greater than this number, the build will be failed. If the number
of failures is less than or equal to this value, then the build
will not be failed.- Type:
int
- Since:
3.10.0
- Required:
No
- User Property:
pmd.maxAllowedViolations
- Default:
0
<printFailingErrors>
Print details of errors that cause build failure
- Type:
boolean
- Since:
3.0
- Required:
No
- User Property:
pmd.printFailingErrors
- Default:
false
<skip>
Skip the PMD checks. Most useful on the command line via
"-Dpmd.skip=true".
- Type:
boolean
- Since:
2.0
- Required:
No
- User Property:
pmd.skip
- Default:
false
<targetDirectory>
The location of the XML report to check, as generated by the PMD
report.
- Type:
java.io.File
- Since:
2.0
- Required:
Yes
- User Property:
project.build.directory
<verbose>
Print details of check failures to build output.
- Type:
boolean
- Since:
2.0
- Required:
No
- User Property:
pmd.verbose
- Default:
false