CodeNarcExtension

API Documentation:CodeNarcExtension

Properties

PropertyDescription
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 html, xml, text, console.

reportsDir

The directory where reports will be generated.

sourceSets

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

toolVersion

The version of the code quality tool to be used.

Property details

File configFile

The CodeNarc configuration file to use.

Default with codenarc plugin:
${project.projectDir}/config/codenarc/codenarc.xml
Default with code-quality plugin:
project.codeNarcConfigFile

boolean ignoreFailures

Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true

Default:
false

int maxPriority1Violations

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

Default with codenarc plugin:
0
Default with code-quality plugin:
0

int maxPriority2Violations

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

Default with codenarc plugin:
0
Default with code-quality plugin:
0

int maxPriority3Violations

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

Default with codenarc plugin:
0
Default with code-quality plugin:
0

String reportFormat

The format type of the CodeNarc report. One of html, xml, text, console.

Default with codenarc plugin:
html
Default with code-quality plugin:
project.codeNarcReportsFormat

File reportsDir

The directory where reports will be generated.

Collection<SourceSet> sourceSets

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.

Script blocks

No script blocks

Methods

No methods