| Property | Optional? | Description |
|---|
| maven.checkstyle.dir |
Yes |
Output directory for output checkstyle files
Default ${maven.build.dir}/checkstyle.
|
| maven.checkstyle.includes |
Yes |
Specifies a comma-separated list of Ant patterns to use
when matching files in the source tree to be included in the
Checkstyle report. The pattern specified is relative to
${maven.src.dir}. The default value is
**/*.java, which matches all Java source files
in the source tree (specified by the ${maven.src.dir}
property.
|
| maven.checkstyle.excludes |
Yes |
Specifies a comma-separated list of Ant patterns to use when
matching files in the source tree to be excluded from the
Checkstyle report. The pattern specified is relative to
${maven.src.dir}. The default value is to not
exclude any files.
|
| maven.checkstyle.check.tests |
Yes |
Whether to check test sources or not.
The default value is true.
|
| maven.checkstyle.format |
Yes |
Specifies what predefined check set to use. Available sets are
"sun" (for the Sun coding conventions), "turbine" and "avalon".
Default value is sun.
|
| maven.checkstyle.properties |
Yes |
Specifies the location of the checkstyle properties that will be
used to check the source. Note that you will need to use this
property only if you don't want to use any of the predefined
formats (see maven.checkstyle.format).
|
| maven.checkstyle.propertiesURL |
Yes |
Specifies the URL of the checkstyle properties that will be
used to check the source. Note that you will need to use this
property only if you don't want to use any of the predefined
formats (see maven.checkstyle.format).
|
| maven.checkstyle.header.file |
Yes |
Specifies the location of the License file (a.k.a the header file)
that is used by Checkstyle to verify that source code has the
correct copyright. Default value is
${maven.license.licenseFile}.
|
| maven.checkstyle.fail.on.violation |
Yes |
Specifies if the build should fail upon a violation.
The default value is false.
|
| maven.checkstyle.cache.file |
Yes |
Specifies the cache file used to speed up Checkstyle on
successive runs. The default value is
${maven.checkstyle.dir}/checkstyle-cachefile.
|
| maven.checkstyle.usefile |
Yes |
If false, the checkstyle task will display violations on stdout.
If true, a text file will be created with the violations. Note:
this is in addition to the XML result file (containing the
violations in XML format) which is always created.
|
| maven.checkstyle.suppressions.file |
Yes |
Specifies the location of the suppressions file to use. The plugin
defines a Checkstyle property named
checkstyle.suppressions.file with the value of this
property. This allows using the Checkstyle property your own
custom checkstyle configuration file when specifying a
suppressions file.
|
| maven.checkstyle.output.xml |
Yes |
Output file where the xml report is written.
Defaults to ${maven.checkstyle.dir}/checkstyle-raw-report.xml.
|
| maven.checkstyle.output.txt |
Yes |
Output file where the txt report is written.
Defaults to ${maven.checkstyle.dir}/checkstyle-raw-report.txt.
|
| maven.checkstyle.output.summary.xml |
Yes |
Output file where the xml summary report is written.
Defaults to ${maven.checkstyle.dir}/checkstyle-summary-report.xml.
|
