Chapter 61. The CodeNarc Plugin

Table of Contents

61.1. Usage
61.2. Tasks
61.3. Project layout
61.4. Dependency management
61.5. Configuration

The CodeNarc plugin performs quality checks on your project’s Groovy source files using CodeNarc and generates reports from these checks.

61.1. Usage

To use the CodeNarc plugin, include the following in your build script:

Example 61.1. Using the CodeNarc plugin

build.gradle

apply plugin: 'codenarc'

The plugin adds a number of tasks to the project that perform the quality checks when used with the Groovy Plugin. You can execute the checks by running gradle check.

61.2. Tasks

The CodeNarc plugin adds the following tasks to the project:

Table 61.1. CodeNarc plugin - tasks

Task name Depends on Type Description

codenarcMain

-

CodeNarc

Runs CodeNarc against the production Groovy source files.

codenarcTest

-

CodeNarc

Runs CodeNarc against the test Groovy source files.

codenarcSourceSet

-

CodeNarc

Runs CodeNarc against the given source set’s Groovy source files.

The CodeNarc plugin adds the following dependencies to tasks defined by the Groovy plugin.

Table 61.2. CodeNarc plugin - additional task dependencies

Task name Depends on

check

All CodeNarc tasks, including codenarcMain and codenarcTest.

61.3. Project layout

The CodeNarc plugin expects the following project layout:

Table 61.3. CodeNarc plugin - project layout

File Meaning

config/codenarc/codenarc.xml

CodeNarc configuration file

61.4. Dependency management

The CodeNarc plugin adds the following dependency configurations:

Table 61.4. CodeNarc plugin - dependency configurations

Name Meaning

codenarc

The CodeNarc libraries to use

61.5. Configuration

See the CodeNarcExtension class in the API documentation.