CodeNarc Maven Plugin – Plugin Documentation

Plugin Documentation

Goals available for this plugin:

Goal	Report?	Description
codenarc:codenarc	Yes	Create a CodeNarc report (implies the execution of the `verify` goal)
codenarc:help	No	Display help information on codenarc-maven-plugin. Call `mvn codenarc:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
codenarc:verify	No	Perform CodeNarc analysis, and optionally fail the build if specified quality criteria are not met

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.6.0
JDK	11
Memory	No minimum requirement.
Disk Space	No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>io.github.crizzis</groupId>
          <artifactId>codenarc-maven-plugin</artifactId>
          <version>0.1</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>io.github.crizzis</groupId>
        <artifactId>codenarc-maven-plugin</artifactId>
        <version>0.1</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>io.github.crizzis</groupId>
        <artifactId>codenarc-maven-plugin</artifactId>
        <version>0.1</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"