Table of Contents
| API Documentation: | CodeNarcExtension |
|---|
Configuration options for the CodeNarc plugin.
| Property | Description |
config | The CodeNarc configuration to use. Replaces the |
configFile | The CodeNarc configuration file to use. |
ignoreFailures | Whether 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. |
The CodeNarc configuration to use. Replaces the configFile property.
- Default with
codenarcplugin: ${project.projectDir}/config/codenarc/codenarc.xml
The CodeNarc configuration file to use.
- Default with
codenarcplugin: ${project.projectDir}/config/codenarc/codenarc.xml
Whether 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
The format type of the CodeNarc report. One of html, xml, text, console.
- Default with
codenarcplugin: html
The directory where reports will be generated.
The source sets to be analyzed as part of the check and build tasks.
- Default:
project.sourceSets
The version of the code quality tool to be used.