Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. By default it supports the Google Java Style Guide and Sun Code Conventions, but is highly configurable. It can be invoked with an ANT task and a command line program.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.ci Issue #5832: Add javadoc and xdoc Example for AbbreviationAsWordInName Oct 16, 2018
.circleci Issue #6093: fix problem with circle-ci ability to restore cache Aug 29, 2018
.github Issue #5791: wrap lines at .github and some files root of repo May 17, 2018
config config: bump saxon to 9.9.0-1 Oct 20, 2018
src doc: release notes 8.14 Oct 21, 2018
.gitattributes Issue #5891: renamed package grammars to grammar Jul 23, 2018
.gitignore minor: change description for .ci-temp folder May 23, 2018
.travis.yml Issue #6055: fix Travis CI build on OSX Aug 3, 2018
Jenkinsfile minor: disable Jenkins timestamps to fix periodical build failures Aug 11, 2018
LICENSE minor: update for license wording from https://www.gnu.org/licenses/o… Jan 7, 2017
LICENSE.apache20 chmod all files to 644 Oct 5, 2013
README.md doc: fix download URLs Jul 1, 2018
RIGHTS.antlr Remove obsolete double spaces Mar 10, 2015
appveyor.yml config: add more files to skip_commits for appveyor Jun 25, 2018
buddy.yml Issue #5793: remove clone_depth from buddy.yml May 14, 2018
codeship-services.yml Issue #3807: codeship pro parallel May 5, 2018
codeship-steps.yml config: let codeship run on branches to be used in PRs from the same … May 30, 2018
distelli-manifest.yml Issue #5953: Add the initial Jenkinsfile Jun 24, 2018
pom.xml [maven-release-plugin] prepare for next development iteration Oct 21, 2018
release.sh config: update release.sh to restore folder with links to old versions Jun 30, 2018
shippable.yml Issue #5953: Add the initial Jenkinsfile Jun 24, 2018
wercker.yml Issue #6018: Add to CI import order validation Jul 13, 2018

README.md

Members chat: Contributors chat:

Checkstyle is a tool for checking Java source code for adherence to a Code Standard or set of validation rules (best practices).

The latest release version can be found at GitHub releases or at Maven repo.

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

Documentation is available in HTML format, see http://checkstyle.sourceforge.net/checks.html.

Continuous integration and Quality reports

Travis (Linux & MacOS build): AppVeyor (Windows build): Distelli CI

Quality reports: http://checkstyle.sourceforge.net/project-reports.html

JavaScript, CSS and Java source file analysis on Codacy:

Feedback/Support

Please send any feedback to https://groups.google.com/forum/?hl=en#!forum/checkstyle

Questions and Answers from community:

Bugs and Feature requests (not the questions): http://www.oddjack.com/?certs=checkstyle/checkstyle/issues

Support/Sponsor checkstyle

If you want to speed up fixing of issue and want to encourage somebody in internet to resolve any issue:

Licensing

This software is licensed under the terms in the file named "LICENSE" in this directory.

The software uses the ANTLR package (http://www.antlr.org/). Its license terms are in the file named "RIGHTS.antlr" in this directory.

This product includes software developed by The Apache Software Foundation (http://www.apache.org/).

The software uses the Cli, Logging and Beanutils packages from the Apache Commons project (http://commons.apache.org/). The license terms of these packages are in the file named "LICENSE.apache20" in this directory.

The software uses the Google Guava Libraries (http://www.oddjack.com/?certs=google/guava/). The license terms of these packages are in the file named "LICENSE.apache20" in this directory.