gradle/org.gradle.api.plugins.quality/CodeNarcExtension

CodeNarcExtension

abstract class CodeNarcExtension : CodeQualityExtension(source)

Configuration options for the CodeNarc plugin.

See also

Constructors

Link copied to clipboard
constructor(project: Project)

Properties

Link copied to clipboard
open var config: TextResource

Functions

Link copied to clipboard
open fun getConfigFile(): File
The CodeNarc configuration file to use.
Link copied to clipboard
abstract fun getIgnoreFailures(): Property<Boolean>
Whether to allow the build to continue if there are warnings.
Link copied to clipboard
Link copied to clipboard
abstract fun getMaxPriority1Violations(): Property<Integer>
The maximum number of priority 1 violations allowed before failing the build.
Link copied to clipboard
abstract fun getMaxPriority2Violations(): Property<Integer>
The maximum number of priority 2 violations allowed before failing the build.
Link copied to clipboard
abstract fun getMaxPriority3Violations(): Property<Integer>
The maximum number of priority 3 violations allowed before failing the build.
Link copied to clipboard
abstract fun getReportFormat(): Property<String>
The format type of the CodeNarc report.
Link copied to clipboard
abstract fun getReportsDir(): DirectoryProperty
The directory where reports will be generated.
Link copied to clipboard
abstract fun getSourceSets(): ListProperty<SourceSet>
The source sets to be analyzed as part of the check and build tasks.
Link copied to clipboard
abstract fun getToolVersion(): Property<String>
The version of the code quality tool to be used.
Link copied to clipboard
open fun setConfigFile(file: File)
The CodeNarc configuration file to use.
Link copied to clipboard
open fun setIgnoreFailures(ignoreFailures: Boolean)
Whether to allow the build to continue if there are warnings.
Link copied to clipboard
open fun setMaxPriority1Violations(maxPriority1Violations: Int)
The maximum number of priority 1 violations allowed before failing the build.
Link copied to clipboard
open fun setMaxPriority2Violations(maxPriority2Violations: Int)
The maximum number of priority 2 violations allowed before failing the build.
Link copied to clipboard
open fun setMaxPriority3Violations(maxPriority3Violations: Int)
The maximum number of priority 3 violations allowed before failing the build.
Link copied to clipboard
open fun setReportFormat(reportFormat: String)
Sets the format type of the CodeNarc report.
Link copied to clipboard
open fun setReportsDir(reportsDir: File)
The directory where reports will be generated.
Link copied to clipboard
open fun setSourceSets(sourceSets: Collection<SourceSet>)
The source sets to be analyzed as part of the check and build tasks.
Link copied to clipboard
open fun setToolVersion(toolVersion: String)
The version of the code quality tool to be used.
Generated by Dokka
Gradle Kotlin DSL Reference