| API Documentation: | CodeNarcExtension | 
|---|
Configuration options for the CodeNarc plugin.
| Property | Description | 
| config | Incubating The CodeNarc configuration to use. Replaces the  | 
| configFile | The CodeNarc configuration file to use. | 
| ignoreFailures | Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true | 
| maxPriority1Violations | The maximum number of priority 1 violations allowed before failing the build. | 
| maxPriority2Violations | The maximum number of priority 2 violations allowed before failing the build. | 
| maxPriority3Violations | The maximum number of priority 3 violations allowed before failing the build. | 
| reportFormat | The format type of the CodeNarc report. One of  | 
| reportsDir | The directory where reports will be generated. | 
| sourceSets | The source sets to be analyzed as part of the  | 
| toolVersion | The version of the code quality tool to be used. | 
TextResource config
Note: This property is incubating and may change in a future version of Gradle.
The CodeNarc configuration to use. Replaces the configFile property.
- Default with codenarcplugin:
- ${project.projectDir}/config/codenarc/codenarc.xml
File configFile
The CodeNarc configuration file to use.
- Default with codenarcplugin:
- ${project.projectDir}/config/codenarc/codenarc.xml
Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true
- Default:
- false
The maximum number of priority 1 violations allowed before failing the build.
- Default with codenarcplugin:
- 0
The maximum number of priority 2 violations allowed before failing the build.
- Default with codenarcplugin:
- 0
The maximum number of priority 3 violations allowed before failing the build.
- Default with codenarcplugin:
- 0
String reportFormat
The format type of the CodeNarc report. One of html, xml, text, console.
- Default with codenarcplugin:
- html
File reportsDir
The directory where reports will be generated.
Collection<SourceSet>sourceSets
Collection<SourceSet>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.