| API Documentation: | CheckstyleExtension | 
|---|
Configuration options for the Checkstyle plugin.
| Property | Description | 
| config | Incubating The Checkstyle configuration to use. Replaces the  | 
| 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 | 
| maxErrors | The maximum number of errors that are tolerated before breaking the build
or setting the failure property. Defaults to  | 
| maxWarnings | The maximum number of warnings that are tolerated before breaking the build
or setting the failure property. Defaults to  | 
| 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. | 
TextResource config
Note: This property is incubating and may change in a future version of Gradle.
The Checkstyle configuration to use. Replaces the configFile property.
- Default with checkstyleplugin:
- ${project.projectDir}/config/checkstyle/checkstyle.xml
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
The maximum number of errors that are tolerated before breaking the build
or setting the failure property. Defaults to 0.
Example: maxErrors = 42
- Default with checkstyleplugin:
- 0
The maximum number of warnings that are tolerated before breaking the build
or setting the failure property. Defaults to Integer.MAX_VALUE.
Example: maxWarnings = 1000
- Default with checkstyleplugin:
- Integer.MAX_VALUE
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.