| API Documentation: | CheckstyleExtension |
|---|
| Property | Description |
configFile | The Checkstyle configuration file to use. |
configProperties | The properties available for use in the configuration file. These are substituted into the configuration file. |
ignoreFailures | Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true |
reportsDir | The directory where reports will be generated. |
showViolations | Whether or not rule violations are to be displayed on the console. Defaults to |
sourceSets | The source sets to be analyzed as part of the |
toolVersion | The version of the code quality tool to be used. |
File configFile
The Checkstyle configuration file to use.
- Default with
checkstyleplugin: ${project.projectDir}/config/checkstyle/checkstyle.xml
The properties available for use in the configuration file. These are substituted into the configuration file.
- Default with
checkstyleplugin: [:]
Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true
- Default:
false
File reportsDir
The directory where reports will be generated.
Whether or not rule violations are to be displayed on the console. Defaults to true.
Example: showViolations = false
- Default with
checkstyleplugin: true
Collection<SourceSet>sourceSets
Collection<SourceSet>The source sets to be analyzed as part of the check and build tasks.
- Default:
project.sourceSets
String toolVersion
The version of the code quality tool to be used.