Checkstyle

Checkstyle is a static analysis tool that checks Java source code against a set of coding standards. It enforces formatting, naming, and structural rules.

Specs Using Checkstyle

Quick Start

Maven

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.3.1</version>
    <configuration>
        <configLocation>config/checkstyle/checkstyle.xml</configLocation>
    </configuration>
</plugin>

Config Location

config/checkstyle/checkstyle.xml

Trigger Policy

Runs on every push. Violations fail the build.

Guides

Guides for this tool will be added as the project evolves.