Table of Contents
The CodeNarc plugin performs quality checks on your project’s Groovy source files using CodeNarc and generates reports from these checks.
To use the CodeNarc plugin, include the following in your build script:
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
.
The CodeNarc plugin adds the following tasks to the project:
CodeNarc plugin - tasks
The CodeNarc plugin adds the following dependencies to tasks defined by the Groovy plugin.
CodeNarc plugin - additional task dependencies
Task name | Depends on |
|
All CodeNarc tasks, including |
The CodeNarc plugin expects the following project layout:
CodeNarc plugin - project layout
File | Meaning |
|
CodeNarc configuration file |
The CodeNarc plugin adds the following dependency configurations:
CodeNarc plugin - dependency configurations
Name | Meaning |
|
The CodeNarc libraries to use |
See the CodeNarcExtension
class in the API documentation.