open class CodeNarcExtension : CodeQualityExtension
Configuration options for the CodeNarc plugin.
See Also
CodeNarc
CodeNarcExtension(project: Project) |
open fun getConfig(): TextResource
The CodeNarc configuration to use. Replaces the |
|
open fun getConfigFile(): File
The CodeNarc configuration file to use. |
|
open fun getMaxPriority1Violations(): Int
The maximum number of priority 1 violations allowed before failing the build. |
|
open fun getMaxPriority2Violations(): Int
The maximum number of priority 2 violations allowed before failing the build. |
|
open fun getMaxPriority3Violations(): Int
The maximum number of priority 3 violations allowed before failing the build. |
|
open fun getReportFormat(): String
The format type of the CodeNarc report. One of html, xml, text, console. |
|
open fun setConfig(config: TextResource): Unit
The CodeNarc configuration to use. Replaces the |
|
open fun setConfigFile(file: File): Unit
The CodeNarc configuration file to use. |
|
open fun setMaxPriority1Violations(maxPriority1Violations: Int): Unit
The maximum number of priority 1 violations allowed before failing the build. |
|
open fun setMaxPriority2Violations(maxPriority2Violations: Int): Unit
The maximum number of priority 2 violations allowed before failing the build. |
|
open fun setMaxPriority3Violations(maxPriority3Violations: Int): Unit
The maximum number of priority 3 violations allowed before failing the build. |
|
open fun setReportFormat(reportFormat: String): Unit
The format type of the CodeNarc report. One of html, xml, text, console. |
open fun getReportsDir(): File
The directory where reports will be generated. |
|
open fun getSourceSets(): MutableCollection<SourceSet>
The source sets to be analyzed as part of the check and build tasks. |
|
open fun getToolVersion(): String
The version of the code quality tool to be used. |
|
open fun isIgnoreFailures(): Boolean
Whether to allow the build to continue if there are warnings. Example: ignoreFailures = true |
|
open fun setIgnoreFailures(ignoreFailures: Boolean): Unit
Whether to allow the build to continue if there are warnings. Example: ignoreFailures = true |
|
open fun setReportsDir(reportsDir: File): Unit
The directory where reports will be generated. |
|
open fun setSourceSets(sourceSets: MutableCollection<SourceSet>): Unit
The source sets to be analyzed as part of the check and build tasks. |
|
open fun setToolVersion(toolVersion: String): Unit
The version of the code quality tool to be used. |
val CodeNarcExtension.ext: ExtraPropertiesExtension
Retrieves the ext extension. |
fun CodeNarcExtension.ext(configure: ExtraPropertiesExtension.() -> Unit): Unit
Configures the ext extension. |