CheckstyleExtension

API Documentation:CheckstyleExtension

Properties

PropertyDescription
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 true. Example: showViolations = false

sourceSets

The source sets to be analyzed as part of the check and build tasks.

toolVersion

The version of the code quality tool to be used.

Methods

No methods

Script blocks

No script blocks

Property details

File configFile

The Checkstyle configuration file to use.

Default with checkstyle plugin:
${project.projectDir}/config/checkstyle/checkstyle.xml

Map<String, Object> configProperties

The properties available for use in the configuration file. These are substituted into the configuration file.

Default with checkstyle plugin:
[:]

boolean ignoreFailures

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.

boolean showViolations

Whether or not rule violations are to be displayed on the console. Defaults to true. Example: showViolations = false

Default with checkstyle plugin:
true

Collection<SourceSet> sourceSets

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.