gradle/org.gradle.api.plugins.quality/CheckstyleExtension

CheckstyleExtension

abstract class CheckstyleExtension : CodeQualityExtension(source)

Configuration options for the Checkstyle plugin.

See also

Constructors

Link copied to clipboard
constructor(project: Project)

Properties

Link copied to clipboard
open var config: TextResource
Link copied to clipboard
open var configProperties: Map<String, Any>
Link copied to clipboard
open var maxErrors: Int
Link copied to clipboard
open var maxWarnings: Int
Link copied to clipboard
open var reportsDir: File
Link copied to clipboard
Link copied to clipboard
open var toolVersion: String

Functions

Link copied to clipboard
abstract fun getConfigDirectory(): DirectoryProperty
Path to other Checkstyle configuration files.
Link copied to clipboard
open fun getConfigFile(): File
The Checkstyle configuration file to use.
Link copied to clipboard
@Incubating
@Optional
@Input
abstract fun getEnableExternalDtdLoad(): Property<Boolean>
Enable the ability to use custom DTD files in config and load them from some location on all checkstyle tasks in this project.
Link copied to clipboard
open fun isIgnoreFailures(): Boolean
Link copied to clipboard
open fun isShowViolations(): Boolean
Whether rule violations are to be displayed on the console.
Link copied to clipboard
open fun setConfigFile(configFile: File)
The Checkstyle configuration file to use.
Link copied to clipboard
inline fun CheckstyleExtension.setConfigProperties(vararg configProperties: Pair<String, Any>)

Kotlin extension function for org.gradle.api.plugins.quality.CheckstyleExtension.setConfigProperties.

Link copied to clipboard
open fun setIgnoreFailures(ignoreFailures: Boolean)
Link copied to clipboard
open fun setShowViolations(showViolations: Boolean)
Whether rule violations are to be displayed on the console.