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.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci Issue #4978: renamed sub-children filters to filter element Feb 18, 2019
.circleci Issue #4684: added missing classes to pitest Dec 9, 2018
.github minor: fix build problem with long line Nov 16, 2018
config Issue #6397: upgraded picocli to 3.9.5 Feb 19, 2019
src Issue #6397: upgraded picocli to 3.9.5 Feb 19, 2019
.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 #6228: set up JDK11 build Dec 27, 2018
Jenkinsfile Issue #6359: switch Jenkins from Hyper.sh to AWS EC2 spot instances Jan 9, 2019
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 Issue #6236: add build instructions to website Feb 4, 2019
RIGHTS.antlr minor: fix antlr links to be https (linkcheck plugin) Nov 10, 2018
appveyor.yml Issue #6228: set up JDK11 build Dec 27, 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 Issue #6397: upgraded picocli to 3.9.5 Feb 19, 2019
release.sh Issue #6333: excution mvn site in checkouted folder, it is still not … Jan 27, 2019
shippable.yml Issue #5953: Add the initial Jenkinsfile Jun 24, 2018
wercker.yml Issue #6167: Add equalsverifier project to wrecker ci Oct 27, 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 https://checkstyle.org/checks.html.

Build instructions and Contribution

Build instructions

Setup IDE for development

Explanation on how to create your own module

Verification of code quality

Sending Pull Request

Report Issue

Continuous integration and Quality reports

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

Quality reports: https://checkstyle.org/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 (https://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 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.

The software uses the Picocli Library (http://www.oddjack.com/?certs=remkop/picocli/). Its license terms are in the file named "LICENSE.apache20" in this directory.