CodeNarc

The CodeNarc project provides a static analysis tool and framework for analyzing Groovy source code.

CodeNarc scans Groovy source code, looking for violations of predefined or custom rules and generates an HTML report of the results. These rules include checks for coding standards, or searching for unused code, possible bugs or bad coding practices.

You can run CodeNarc using the supplied Ant Task or from the command-line .

See the site navigation menu for a list of the rulesets and rules provided out of the box by CodeNarc . Or you can create your own custom ruleset

Take a look at a Sample CodeNarc Report , or example reports from popular Groovy-based open source projects .

CodeNarc plugins are available for Grails and Griffon .

CodeNarc was influenced by the wonderful PMD and Checkstyle tools for analyzing Java source code, as well as others.

Requirements

The CodeNarc project requires:

  • Groovy version 1.5.6 or later
  • The Log4J jar, version 1.2.13 or later, accessible on the classpath.
  • If you are using Java 1.4, then you will also need JAXP on the classpath.

Compatibility Testing

CodeNarc has been tested with:

  • Groovy 1.5.6, 1.5.7 and 1.6.0
  • Java 1.4, 1.5 and 1.6

Getting CodeNarc from the Maven2 Central Repository

For projects built using Maven , CodeNarc is now available from the Maven Central Repository .

  • groupId = org.codenarc
  • artifactId = CodeNarc