CodeNarc - Integration with Other Tools / Frameworks

IDEs

• IntelliJ IDEA - See the IDEA CodeNarc Plugin.

• Visual Studio Code - See the VsCode Groovy Lint extension.

Docker

See CodeNarc - Docker.

Application Frameworks

• Grails - See the Grails CodeNarc Plugin for Grails 2.x. Use the Gradle CodeNarc Plugin for Grails 3.x and later. Also see Static code analysis in a Grails app with CodeNarc.

• Griffon - See the Griffon CodeNarc Plugin

Build and Code Quality Tools

• Gradle build system - See the Gradle CodeNarc Plugin.
  • See #630 for info on controlling the version of Groovy that CodeNarc uses for the Gradle plugin. e.g.

        dependencies {
            codenarc('org.codenarc:CodeNarc:3.2.0')
            codenarc('org.codehaus.groovy:groovy-all:3.0.9')
        }
    

• Maven - See the Maven CodeNarc Plugin

• Jenkins - The Jenkins Warnings NG Plugin includes reporting and trending of CodeNarc violations.

• SonarQube - The Sonar Groovy Plugin uses CodeNarc for its static analysis of Groovy source code.

• NPM Groovy Lint - NPM CodeNarc wrapper to easily lint, format and fix Groovy files and Jenkinsfile via command line. Uses CodeNarc for its static analysis of Groovy source code.

Customizing ClassLoader for Loading Rule Scripts

Grails (and possibly other tools integrating with CodeNarc) can benefit from using the current thread context ClassLoader for loading rule script files, rather than the default base ClassLoader. Setting the “codenarc.useCurrentThreadContextClassLoader” system property to “true” uses the current thread context ClassLoader for loading rule script files. That enables Grails to load rule script files from within the Grails project, and allows those rule scripts to reference local classes. See GPCODENARC-32. The Grails CodeNarc Plugin automatically sets that system property.