maven.checkstyle.useFile property.
- 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.
- | Goal | Description |
|---|---|
| checkstyle | -
- This is the default goal of the plugin. It simply calls the
- checkstyle:report goal.
- |
-
| checkstyle:report | -- Generates an xml report from the source code showing how well the - code conforms to the - Checkstyle - definitions defined by the project. - | -
- This plugin generates a nicely formatted - Checkstyle report so - code violations can be easily found and corrected. -
-| Date | -Description | -
|---|---|
| 31 May 2003 | -- New migration guide to help migrate from - version 1.x to 2.x. - | -
| 30 May 2003 | -- New development version 2.0 created. First cut at supporting - Checkstyle 3.1. - | -
| 30 May 2003 | -- Release of version 1.1 (compatible with Checkstyle 2.4). - | -
- The Checkstyle plugin version 1.x was using Checkstyle 2.x and the new
- 2.x versions uses Checkstyle 3.x. The Maven goals for the Checkstyle
- plugins have not changed and the way to invoke it can either be
- maven checkstyle or maven checkstyle:report.
-
- Some properties have changed. The most
- important change is probably the addition of a
- maven.checkstyle.header.file one to point to your
- License file.
-
- The major migration step is to migrate your previous Checkstyle
- properties (located in a properties file) to the new XML configuration
- file introduced by Checkstyle 3.x. The new configuration is described
- on the
- Checkstyle
- config page. An example is provided
- here.
- Once you have finished migrating your Checkstyle configuration, modify
- the maven.checkstyle.properties property point to the
- new XML file.
-
| 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.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.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
- ${basedir}/LICENSE.txt
- |
-
| 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. - | -
| Date | -Description | -
|---|---|
| 31 May 2003 | -- New migration guide to help migrate from - version 1.x to 2.x. - | -
| 30 May 2003 | -- New development version 2.0 created. First cut at supporting - Checkstyle 3.1. - | -
| 30 May 2003 | -- Release of version 1.1 (compatible with Checkstyle 2.4). - | -