Plugin Documentation

Goals available for this plugin:

GoalReport?Description
checkstyle:checkNoPerform a violation check against the last Checkstyle run to see if there are any violations. It reads the Checkstyle output file, counts the number of violations found and displays it on the console.
checkstyle:checkstyleYesPerform a Checkstyle analysis, and generate a report on violations.
checkstyle:checkstyle-aggregateYesPerform a Checkstyle analysis, and generate a report on violations, aggregating the result in the project which started this mojo.
checkstyle:helpNoDisplay help information on maven-checkstyle-plugin.
Call 
  mvn checkstyle:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.

System Requirements

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

Maven2.2.1
JDK1.5
MemoryNo minimum requirement.
Disk SpaceNo 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>org.apache.maven.plugins</groupId>
          <artifactId>maven-checkstyle-plugin</artifactId>
          <version>2.9.1</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.9.1</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.9.1</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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