Analyzing code with the Maven Checkstyle plugin

Checkstyle is a tool that helps programmers follow coding standards. It automates the process of checking if defined coding standards are followed. It can support any coding standards by suitable configuration. Like other tools, it can be run standalone as well as integrated with Maven.

How to do it...

Use the following steps to analyze code with the Maven Checkstyle plugin:

  1. Open the Maven project for which you want to do a Checkstyle analysis (for instance, project-with-violations).
  2. Run the following command:
    mvn checkstyle:checkstyle
  3. Observe the output as shown in the following screenshot:
    [INFO]
[INFO] --- maven-checkstyle-plugin:2.13:checkstyle (default-cli) @ project-with-violations ---
[INFO]
[INFO] ...

Get Apache Maven Cookbook now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial