checkstyle

(โ˜… 8,994)

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.

Showing a partial file list โ€” download the zip above to see everything.

  • .gitattributes
  • .gitignore
  • .mdlrc
  • .shellcheckrc
  • appveyor.yml
  • azure-pipelines.yml
  • cdg-pitest-licence.txt
  • LICENSE
  • LICENSE.apache20
  • mvnw
  • mvnw.cmd
  • pom.xml
  • README.md
  • RIGHTS.antlr
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/checkstyle/checkstyle

Downloads the entire project code from GitHub to your computer.

cd checkstyle

Moves into the project folder you just downloaded.

2. Maven (Java)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn clean install

Installs dependencies and builds the project using Maven.

โœ… A BUILD SUCCESS message means it worked. The output is created under target/.
// repository documentation