Full name:
org.apache.maven.plugins:maven-checkstyle-plugin:2.5:check
Description:
Attributes:
compile
.verify
.Name | Type | Since | Description |
---|---|---|---|
includes | String |
- |
Specifies the names filter of the source files to be used for
Checkstyle. Default value is: **/*.java . |
sourceDirectory | File |
- |
Specifies the location of the source directory to be used for
Checkstyle. Default value is: ${project.build.sourceDirectory} . |
Name | Type | Since | Description |
---|---|---|---|
cacheFile | String |
- |
Specifies the cache file used to speed up Checkstyle on successive
runs. Default value is: ${project.build.directory}/checkstyle-cachefile . |
configLocation | String |
2.5 |
Specifies the location of the XML configuration to use. Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle Checker module) configuration of rulesets. This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the configuration is copied
into the
There are 4 predefined rulesets.
Default value is: config/sun_checks.xml . |
consoleOutput | boolean |
- |
Output errors to console. Default value is: false . |
encoding | String |
2.2 |
The file encoding to use when reading the source files. If the
property project.build.sourceEncoding is not set, the
platform default encoding is used. Note: This
parameter always overrides the property charset from
Checkstyle's TreeWalker module.Default value is: ${project.build.sourceEncoding} . |
excludes | String |
- |
Specifies the names filter of the source files to be excluded for
Checkstyle. |
failOnViolation | boolean |
- |
Do we fail the build on a violation? Default value is: true . |
failsOnError | boolean |
- |
Specifies if the build should fail upon a violation. Default value is: false . |
headerLocation | String |
2.0-beta-2 |
Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header. You need to use ${checkstyle.header.file} in your Checkstyle xml configuration to reference the name of this header file. For instance:
Default value is: LICENSE.txt . |
includeTestSourceDirectory | boolean |
2.2 |
Include or not the test source directory to be used for Checkstyle. Default value is: ${false} . |
logViolationsToConsole | boolean |
2.3 |
Output the detected violations to the console. Default value is: false . |
maxAllowedViolations | int |
2.3 |
The maximum number of allowed violations. The execution fails only
if the number of violations is above this limit. Default value is: 0 . |
outputFile | File |
- |
Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
outputFileFormat parameter.Default value is: ${project.build.directory}/checkstyle-result.xml . |
outputFileFormat | String |
- |
Specifies the format of the output to be used when writing to the
output file. Valid values are "plain" and "xml". Default value is: xml . |
propertiesLocation | String |
2.5 |
Specifies the location of the properties file. This parameter is resolved as URL, File then resource. If
successfully resolved, the contents of the properties location is
copied into the
The contents of the |
propertyExpansion | String |
- |
Allows for specifying raw property expansion information. |
skip | boolean |
2.2 |
Skip entire check. Default value is: false . |
skipExec | boolean |
2.5 |
Skip checktyle execution will only scan the outputFile. Default value is: false . |
suppressionsFileExpression | String |
2.1 |
The key to be used in the properties for the suppressions file. Default value is: checkstyle.suppressions.file . |
suppressionsLocation | String |
2.0-beta-2 |
Specifies the location of the suppressions XML file to use. This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
See |
testSourceDirectory | File |
2.2 |
Specifies the location of the test source directory to be used for
Checkstyle. Default value is: ${project.build.testSourceDirectory} . |
useFile | File |
- |
If null , the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
violations. |
violationSeverity | String |
2.2 |
The lowest severity level that is considered a violation. Valid
values are "error", "warning" and "info". Default value is: error . |
java.lang.String
No
${project.build.directory}/checkstyle-cachefile
Specifies the location of the XML configuration to use.
Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle Checker module) configuration of rulesets.
This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the configuration is copied
into the
${project.build.directory}/checkstyle-configuration.xml
file before being passed to Checkstyle as a configuration.
There are 4 predefined rulesets.
config/sun_checks.xml
: Sun Checks.config/turbine_checks.xml
: Turbine Checks.config/avalon_checks.xml
: Avalon Checks.config/maven_checks.xml
: Maven Source Checks.java.lang.String
2.5
No
${checkstyle.config.location}
config/sun_checks.xml
boolean
No
false
project.build.sourceEncoding
is not set, the
platform default encoding is used. Note: This
parameter always overrides the property charset
from
Checkstyle's TreeWalker
module.java.lang.String
2.2
No
${encoding}
${project.build.sourceEncoding}
java.lang.String
No
${checkstyle.excludes}
boolean
No
${checkstyle.failOnViolation}
true
boolean
No
false
Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.
You need to use ${checkstyle.header.file} in your Checkstyle xml configuration to reference the name of this header file.
For instance:
<module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
</module>
java.lang.String
2.0-beta-2
No
${checkstyle.header.file}
LICENSE.txt
boolean
2.2
No
${false}
java.lang.String
Yes
${checkstyle.includes}
**/*.java
boolean
2.3
No
${checkstyle.console}
false
int
2.3
No
${checkstyle.maxAllowedViolations}
0
outputFileFormat
parameter.java.io.File
No
${checkstyle.output.file}
${project.build.directory}/checkstyle-result.xml
java.lang.String
No
${checkstyle.output.format}
xml
Specifies the location of the properties file.
This parameter is resolved as URL, File then resource. If
successfully resolved, the contents of the properties location is
copied into the
${project.build.directory}/checkstyle-checker.properties
file before being passed to Checkstyle for loading.
The contents of the propertiesLocation
will be made
available to Checkstyle for specifying values for parameters within
the xml configuration (specified in the configLocation
parameter).
java.lang.String
2.5
No
${checkstyle.properties.location}
java.lang.String
No
skip:
boolean
2.2
No
${checkstyle.skip}
false
boolean
2.5
No
${checkstyle.skipExec}
false
java.io.File
Yes
${project.build.sourceDirectory}
java.lang.String
2.1
No
${checkstyle.suppression.expression}
checkstyle.suppressions.file
Specifies the location of the suppressions XML file to use.
This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
${project.build.directory}/checkstyle-supressions.xml
file before being passed to Checkstyle for loading.
See suppressionsFileExpression
for the property
that will be made available to your checkstyle configuration.
java.lang.String
2.0-beta-2
No
${checkstyle.suppressions.location}
java.io.File
2.2
No
${project.build.testSourceDirectory}
null
, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
violations.java.io.File
No
java.lang.String
2.2
No
${checkstyle.violationSeverity}
error