Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.
Checkstyle is highly configurable and can be made to support almost any coding standard. An example configuration files are supplied supporting the Sun Code Conventions, Google Java Style.
A good example of a report that can be produced using Checkstyle and Maven can be seen here .
Checkstyle can check many aspects of your source code. It can find class design problems, method design problems. It also has the ability to check code layout and formatting issues.
For a detailed list of available checks please refer to the Checks page.
The latest release of Checkstyle can be downloaded from the GitHub releases page, or Maven central.
If you want to live on the bleeding edge, you can checkout the current development code from GitHub and compile yourself. Or use jitpack.io to build and get artifacts you need (you can even build your forked repo).
Current site contains documentation only for latest, released version.
We only support this latest version. We highly recommend read latest documentation first.
However, you might need documentation for previous releases because you are still using
an older version and latest version describe some features that does not work for you.
You can find documentation for most old versions using a URL format like
https://checkstyle.sourceforge.io/version/X.X where "X.X" is the version number.
Example:
https://checkstyle.sourceforge.io/version/6.18
for version 6.18.
Since Checkstyle 7, some users have been unable to continue upgrading to newer versions of the utility because of the new JDK 1.8 compile requirement. The development team doesn't have the resources to keep updating the utility for older JDKs for those that can't work with the latest version.
However, some members of the community have created an unofficial backport of the latest Checkstyle releases to be run with JDKs as old as 1.6. If you wish to continue using new Checkstyle versions on older JDKs, we recommend you either checkout the github site or the documentation site on how to use the backport version of the utility, in place of the official Checkstyle version.
Releases will happen at the end of each month if functional changes exist in the master branch of our repo. For the exact day, please follow our milestones.
Checkstyle is not using Semantic Versioning (reasons in issue #3709)
Checkstyle is a single file static analysis tool, for more details please read the full list of limitations.
Checkstyle is most useful if you integrate it into your build process or your development environment. The distribution includes:
Additionally plug-ins are written by third-parties. Some of them are still based on the Checkstyle 2.4 release, although there have been many improvements since then. The known plug-ins are:
| IDE / Build tool | Main/Initial Author | Available from | Remarks |
|---|---|---|---|
| Bitbucket Server | Stephan Bechter | Checkstyle for Bitbucket Server | |
| Codacy | João Machado | codacy-checkstyle | Provides analysis per commit and per pull request. Supports CheckStyle config files. |
| Eclipse/RAD/RDz | Christian Wulf | Lightweight Eclipse Plugin for Quality Assurance Tools | Alternative to the Eclipse-CS plugin. Allows to use custom checks directly without providing an Eclipse Fragment plugin for that purpose. |
| Eclipse/RAD/RDz | David Schneider | Eclipse-CS Home Page | In 2007 was awarded Best Open Source Eclipse-based Developer tool . |
| Gradle | Hans Dockter (initial author) | Checkstyle supported out of the box | Gradle Checkstyle docs |
| IntelliJ IDEA | James Shiell | Checkstyle-idea Project Page | Provides real-time and on-demand scanning. |
| jGRASP | Larry Barowski | jGRASP Home Page | |
| Eclipse/RAD/RDz | Roman Ivanov | Project Page | Extension for Eclipse-CS plugin and also an incubator for Checkstyle checks that are not present in main stream of Checkstyle. See the Wiki and Blog . |
| Eclipse/RAD/RDz | Jan Burkhardt | Project Page | Extension for Eclipse-CS plugin which ensures nullness annotations on methods and constructors (JSR305). |
| Bamboo Checkstyle plug-in | Atlassian (formerly by Ross Rowe and Stephan Paulicke) | Bamboo Checkstyle plug-in Home Page | An add-on that will parse and record CheckStyle reports and report your style violations over time. |
| Code Climate | Sivakumar Kailasam | codeclimate-checkstyle | |
| Jenkins Checkstyle plug-in | Jenkins Checkstyle plug-in Home Page | This plug-in is supported by the Static Analysis Collector plug-in that collects different analysis results and shows the results in aggregated trend graphs. | |
| Maven | Vincent Massol | Checkstyle supported out of the box | example report |
| tIDE | Built in | ||
| NetBeans | Petr Hejl | Checkstyle Beans | Problems with source code are displayed as annotations of the source |
| NetBeans | Software Quality Environment (SQE) | ||
| SonarQube | Freddy Mallet (initial author) | Checkstyle SonarQube repository | Demo site of SonarQube |
| jEdit | Todd Papaioannou | JEdit CheckStylePlugin | |
| SCM-Manager | SCM-Manager Plugin Page | ||
| IntelliJ IDEA | Jakub Slawinski | QAPlug | Provides quality assurance features. |
| JArchitect | JArchitect Home Page | Imports XML result files from CheckStyle. | |
| SBT | Andrew Johnson | sbt-checkstyle-plugin Project Page | SBT plugin for running Checkstyle on Java source files in an SBT project |
| code-assert | Stefan Niederhauser | code-assert | Assert that the java code of a project satisfies certain checks. Launch checkstyle validation from UTs |
| Emacs JDE | Markus Mohnen | Part of the standard JDEE distribution - | configuration could be seen at jdee-checkstyle.el |
| Visual Studio Code | Sheng Chen | vscode-checkstyle | Checkstyle for Microsoft Visual Studio Code |
| IDE / Build tool | Main/Initial Author | Available from | Remarks |
|---|---|---|---|
| QALab | Benoit Xhenseval | QALab Home Page | Supports tracking Checkstyle statistics over time. |
| Vim editor | Xandy Johnson | Plugin Homepage | Vim file-type plug-in |
If you have written a plugin for other IDEs, please let us know, so we can provide a link here.
