Repository files navigation

Checkstyle is a tool that ensures adherence to a code standard or a set of best practices.

The latest release version can be found atGitHub releasesor atMaven repo.

Each-commit builds of maven artifacts can be found atMaven Snapshot repository.

Documentation is available in HTML format, seehttps://checkstyle.org/checks.html .

• Quick Start
• Contributing
• Feedback and Support
• Javadoc
• Sponsor Checkstyle
• Licensing

• Download ourLatest Release from GitHubor Add Checkstyle to your build fromMaven Central.
• Read our Documentation forusageandconfiguration.

$ cat config.xml<?xml version="1.0"?><!DOCTYPE module PUBLIC"-//Puppy Crawl//DTD Check Configuration 1.3//EN""https://checkstyle.org/dtds/configuration_1_3.dtd"><module name="Checker"><module name="TreeWalker"><module name="FallThrough"/></module></module>$ cat Test.javaclass Test {  public voidfoo() {    int i = 0;while (i>= 0) {      switch (i) {case 1:case 2:          i++;case 3: // violation'fall from previous branch of the switch'          i++;      }    }  }}$ java -jar checkstyle-10.18.1-all.jar -c config.xml Test.javaStarting audit...[ERROR] Test.java:9:9: Fall through from previous branch of switch statement [FallThrough]Audit done.Checkstyle ends with 1 errors.

Thanks for your interest in contributing to CheckStyle! Please see theContribution Guidelinesfor information on how to contribute to the project. This includes creating issues, submitting pullrequests, and setting up your development environment.

Please see theCheckStyle Documentation forinformation on how to build the project.

• Visit ourDiscussions Page, where youcan ask questions and discuss the project with other users and contributors. This is ourpreferred method of communication for topicslike usage and configuration questions, debugging, and other feedback.
• Stack Overflow is another place toask questions about Checkstyle usage.
• If you are interested in contributing to the project, you can join ourDiscord Contributors Chatwith invite link.
• OurGoogle Groups Forum is amailing list for discussion and support; however, we may be slow to respond there.

Take a look at ourjavadoc to seeour API documentation.

Checkstyle is an open-source project that is developed and maintained by volunteers. If youfind Checkstyle useful, please consider sponsoring the project. Your support helps us tomaintain and improve Checkstyle.

• Liberapay
• OpenCollective

Checkstyle is licensed under theGNU LGPL v2.1 License.Checkstyle uses libraries:

• ANTLR
• Apache Commons
• Google Guava
• Picocli