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

CodeNarcExtension

abstract class CodeNarcExtension : CodeQualityExtension(source)

Configuration options for the CodeNarc plugin.

See also

Constructors

CodeNarcExtension

constructor(project: Project)

Properties

open var config: TextResource

Functions

open fun getConfigFile(): File

The CodeNarc configuration file to use.

getIgnoreFailures

abstract fun getIgnoreFailures(): Property<Boolean>

Whether to allow the build to continue if there are warnings.

getIsIgnoreFailures

open fun getIsIgnoreFailures(): Property<Boolean>

getMaxPriority1Violations

abstract fun getMaxPriority1Violations(): Property<Integer>

The maximum number of priority 1 violations allowed before failing the build.

getMaxPriority2Violations

abstract fun getMaxPriority2Violations(): Property<Integer>

The maximum number of priority 2 violations allowed before failing the build.

getMaxPriority3Violations

abstract fun getMaxPriority3Violations(): Property<Integer>

The maximum number of priority 3 violations allowed before failing the build.

getReportFormat

abstract fun getReportFormat(): Property<String>

The format type of the CodeNarc report.

abstract fun getReportsDir(): DirectoryProperty

The directory where reports will be generated.

abstract fun getSourceSets(): ListProperty<SourceSet>

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

abstract fun getToolVersion(): Property<String>

The version of the code quality tool to be used.

open fun setConfigFile(file: File)

The CodeNarc configuration file to use.