Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-checkstyle-plugin:2.12.1:checkstyle-aggregate
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| includeResources | boolean | 2.11 | Specifies whether to include the resource directories in the check. Default value is: true. User property is: checkstyle.includeResources. |
| includeTestResources | boolean | 2.11 | Specifies whether to include the test resource directories in the
check. Default value is: true. User property is: checkstyle.includeTestResources. |
| includes | String | 2.8 | Specifies the names filter of the source files to be used for
Checkstyle. Default value is: **\/*.java. User property is: checkstyle.includes. |
| outputDirectory | File | 2.8 | The output directory for the report. Note that this parameter is
only evaluated if the goal is run directly from the command line.
If the goal is run indirectly as part of a site generation, the
output directory configured in Maven Site Plugin is used instead. Default value is: ${project.reporting.outputDirectory}. |
| resourceIncludes | String | 2.11 | Specifies the names filter of the resource files to be used for
Checkstyle. Default value is: **/*.properties. User property is: checkstyle.resourceIncludes. |
| sourceDirectory | File | 2.8 | Specifies the location of the source directory to be used for
Checkstyle. Default value is: ${project.build.sourceDirectory}. |
| Name | Type | Since | Description |
|---|---|---|---|
| cacheFile | String | 2.8 | Specifies the cache file used to speed up Checkstyle on successive
runs. Default value is: ${project.build.directory}/checkstyle-cachefile. |
| configLocation | String | 2.8 |
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.
Default value is: config/sun_checks.xml. User property is: checkstyle.config.location. |
| consoleOutput | boolean | 2.8 | Output errors to console. Default value is: false. User property is: checkstyle.consoleOutput. |
| enableFilesSummary | boolean | 2.8 | Specifies if the Files summary should be enabled or not. Default value is: true. User property is: checkstyle.enable.files.summary. |
| enableRSS | boolean | 2.8 | Specifies if the RSS should be enabled or not. Default value is: true. User property is: checkstyle.enable.rss. |
| enableRulesSummary | boolean | 2.8 | Specifies if the Rules summary should be enabled or not. Default value is: true. User property is: checkstyle.enable.rules.summary. |
| enableSeveritySummary | boolean | 2.8 | Specifies if the Severity summary should be enabled or not. Default value is: true. User property is: checkstyle.enable.severity.summary. |
| 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}. User property is: encoding. |
| excludes | String | 2.8 | Specifies the names filter of the source files to be excluded for
Checkstyle. User property is: checkstyle.excludes. |
| failsOnError | boolean | 2.8 | 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: <module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module> Default value is: LICENSE.txt. User property is: checkstyle.header.file. |
| includeTestSourceDirectory | boolean | 2.2 | Include or not the test source directory to be used for Checkstyle. Default value is: false. |
| linkXRef | boolean | 2.1 | Link the violation line numbers to the source xref. Will link
automatically if Maven JXR plugin is being used. Default value is: true. User property is: linkXRef. |
| outputFile | File | 2.8 | 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. User property is: checkstyle.output.file. |
| outputFileFormat | String | 2.8 | 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. User property is: checkstyle.output.format. |
| plugin | PluginDescriptor | 2.8 | The Plugin Descriptor Default value is: ${plugin}. |
| project | MavenProject | 2.8 | The Maven Project Object. Default value is: ${project}. |
| propertiesLocation | String | 2.0-beta-2 |
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). User property is: checkstyle.properties.location. |
| propertyExpansion | String | 2.8 | Allows for specifying raw property expansion information. |
| resourceExcludes | String | 2.11 | Specifies the names filter of the resource files to be excluded for
Checkstyle. User property is: checkstyle.resourceExcludes. |
| skip | boolean | 2.2 | Skip entire check. Default value is: false. User property is: checkstyle.skip. |
| suppressionsFileExpression | String | 2.1 | The key to be used in the properties for the suppressions file. Default value is: checkstyle.suppressions.file. User property is: checkstyle.suppression.expression. |
| 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 ${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. User property is: checkstyle.suppressions.location. |
| testSourceDirectory | File | 2.2 | Specifies the location of the test source directory to be used for
Checkstyle. Default value is: ${project.build.testSourceDirectory}. |
| treeWalkerNames | List | 2.11 | When using custom treeWalkers, specify their names here so the
checks inside the treeWalker end up the the rule-summary. |
| useFile | File | 2.8 | If null, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
violations. |
| xrefLocation | File | 2.8 | Location of the Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref. |
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.
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>
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).
skip:
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.