| Property | Optional? | Description |
|---|---|---|
| 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.properties | Yes |
Specifies the location of the checkstyle properties that will be
used to check the source.
There is also a sample file shipped with maven of the Jakarta Turbine project coding style, which maven adheres to. For more information on checkstyle properties, please see the CheckStyle Home Page The default value is
|
| maven.checkstyle.fail.on.violation | Yes |
Specifies if the maven:check-source task
should fail upon a violation. This will stop the build
process. 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.build.dest}/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. |