Skip to content
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.
Java HTML Shell GAP JavaScript CSS
Branch: master
Clone or download

Latest commit

Latest commit f4e92b1 Jun 4, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci Issue #8286: remove rss and sourceforge banners Jun 3, 2020
.circleci Issue #8169: Making regex to validate missed space in comments in non… May 21, 2020
.dependabot Issue #7224: dependabot config to configure commit message Dec 10, 2019
.github Issue #7833: Create code of conduct Apr 28, 2020
config minor: Add input file for Java14 instanceof with pattern matching (#7290 Jun 4, 2020
src Issue #8274: Update java.g to allow new tokens to be added Jun 4, 2020
.gitattributes Issue #6558: set git attributes for all files to enforce LF line endings Sep 15, 2019
.gitignore minor: change description for .ci-temp folder May 23, 2018
.travis.yml minor: fix nonsense message in travis output May 30, 2020
Jenkinsfile config: ensured all maven commands print the stack trace Apr 16, 2020
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: repo1.maven.org demands https Apr 26, 2020
RIGHTS.antlr Issue #5941: remove all unnecessary spaces on end of line Jun 30, 2019
appveyor.yml Issue #8118: Enforce -e for all maven commands Apr 24, 2020
buddy.yml Issue #8169: Making regex to validate missed space in comments in non… May 21, 2020
codeship-services.yml Issue #3807: codeship pro parallel May 5, 2018
codeship-steps.yml Issue #8169: Making regex to validate missed space in comments in non… May 21, 2020
pom.xml dependency: bump forbiddenapis from 3.0 to 3.0.1 Jun 4, 2020
release.sh Issue #6186: automation of github actions for release.sh Jan 27, 2020
shippable.yml Issue #8169: Making regex to validate missed space in comments in non… May 21, 2020
wercker.yml Issue #8228: Update CIs to validate empty output of 'git status' afte… May 20, 2020

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):

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): https://github.com/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 (https://github.com/google/guava/). The license terms of these packages are in the file named "LICENSE.apache20" in this directory.

The software uses the Picocli Library (https://github.com/remkop/picocli/). Its license terms are in the file named "LICENSE.apache20" in this directory.

You can’t perform that action at this time.