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.
Use the following steps to analyze code with the Maven Checkstyle plugin:
Open the Maven project for which you want to do a Checkstyle analysis (for instance,
project-with-violations).Run the following command:
mvn checkstyle:checkstyleObserve the output as shown in the following screenshot:
[INFO] [INFO] --- maven-checkstyle-plugin:2.13:checkstyle (default-cli) @ project-with-violations --- [INFO] [INFO] There are 29 checkstyle errors. [WARNING] Unable to locate Source XRef to link to - DISABLED [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS
Open the
checkstyle-result.xmlreport in thetarget...