CodeNarc - Run From Command-Line

Contents

• CodeNarc Command-Line Parameters
• Executing CodeNarc from the Command-Line
• Running From a Gradle Script
• Docker

CodeNarc can be run from the command-line as a Java application. The org.codenarc.CodeNarc class provides the application entry-point.

CodeNarc Command-Line Parameters

Usage: java org.codenarc.CodeNarc [OPTIONS] where OPTIONS are zero or more command-line parameters of the form “-NAME[=VALUE]”

All command-line parameters are optional. If no parameters are supplied, CodeNarc runs from the current directory with reasonable defaults, as described below.

Executing CodeNarc from the Command-Line

Make sure that the following are included your CLASSPATH:

1. The Groovy-all jar, e.g. https://repo1.maven.org/maven2/org/codehaus/groovy/groovy-all/ (for Groovy 3.0.x).

2. The CodeNarc jar. Use a published CodeNarc release or else build the jar from source (see below).

3. The SLF4J api/implementation jars, e.g. Logback.

4. The directories containing (or relative to) CodeNarc config files such as “codenarc.properties” or ruleset files.

The CodeNarc command-line application sets an exit status of zero (0) if the command successfully executes, and an exit status of one (1) if an error occurs executing CodeNarc, or if an invalid command-line option is specified.

Here is an example BAT file for running CodeNarc on Windows. It assumes the jars are in the current directory.

    @set GROOVY_JAR="groovy-all-2.4.15.jar"
    @set CODENARC_JAR="CodeNarc-1.6.1.jar"
    @set SLF4J_JAR="slf4j-api-1.7.25.jar"
    java -classpath $GROOVY_JAR;$CODENARC_JAR;$SLF4J_JAR org.codenarc.CodeNarc %*

Here is the equivalent Linux command.

    export GROOVY_JAR="groovy-all-2.4.15.jar"
    export CODENARC_JAR="CodeNarc-1.6.1.jar"
    export SLF4J_JAR="slf4j-api-1.7.25.jar"
    java -classpath $GROOVY_JAR:$CODENARC_JAR:$SLF4J_JAR org.codenarc.CodeNarc $*

Running From a Gradle Script

Here is an example Gradle script to run CodeNarc using its command-line interface. It assumes that there is a codenarc.ruleset ruleset file in the current directory.

    apply plugin: 'groovy'

    repositories {
        mavenCentral()
    }

    dependencies {
        // To use a published CodeNarc version
        implementation 'org.codenarc:CodeNarc:3.2.0'
            
        // OR to use a locally built CodeNarc jar; adjust the relative path and jar filename    
        //implementation files('../../CodeNarc/build/libs/CodeNarc-3.2.0.jar')

        implementation 'ch.qos.logback:logback-classic:1.2.3'
    }

    task runCodeNarc(type:JavaExec) {
        main = "org.codenarc.CodeNarc"
        classpath = sourceSets.main.runtimeClasspath

        args "-rulesetfiles=file:codenarc.ruleset"
    }

Docker

See CodeNarc - Docker.

Build the CodeNarc Jar From Source

To build the CodeNarc jar from source:

1. Clone the GitHub repository, e.g git clone https://github.com/CodeNarc/CodeNarc.git.
2. From within the project root directory, execute: ./gradlew jar. That will create a CodeNarc jar within the build/libs directory.