Using the CodeNarc plugin
To check code written in the Groovy language, we can use CodeNarc. CodeNarc has several rules to do a static analysis of Groovy code. Gradle has a CodeNarc plugin, so we can apply the rules from CodeNarc to our Groovy code base. If we apply the plugin, we automatically get a
codenarcMain
and codenarcTest
target. Also, for each custom source set, we get a new task named codenarc<SourceSet>
. All these tasks are dependency tasks of the check
task.
The CodeNarc library is not included with Gradle. We need to define a repository in our build file that contains CodeNarc. If we invoke a codenarc
task, then Gradle sets CodeNarc dependencies. We can change the version of CodeNarc that we want to use by setting the
codenarc.toolVersion
property.
The plugin defines that we provide a CodeNarc configuration file with the name codenarc.xml
in the directory config/codenarc
. We can change the reference to the configuration file with the
configFile
property of the plugin...