Checkstyle Java Tool for Codacy
Java Scala
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
project Update to 8.11 Jul 29, 2018
src/main Update to 8.11 Jul 29, 2018
.gitignore Update README Feb 7, 2018
LICENSE Update README Feb 7, 2018 Update README Feb 7, 2018
build.sbt Update seed Aug 2, 2018
circle.yml Update to 8.11 Jul 29, 2018

Codacy Checkstyle

This is the docker engine we use at Codacy to have Checkstyle support. You can also create a docker to integrate the tool and language of your choice! Check the Docs section for more information.

Codacy Badge Build Status


You can create the docker by doing:

sbt docker:publishLocal

The docker is ran with the following command:

docker run -it -v $srcDir:/src  <DOCKER_NAME>:<DOCKER_VERSION>

Generate Docs

  1. Update the version in src/main/resources/docs/patterns.json

  2. Run the DocGenerator

sbt "run-main codacy.checkstyle.DocGenerator"


Tool Developer Guide

Tool Developer Guide - Using Scala


We use the codacy-plugins-test to test our external tools integration. You can follow the instructions there to make sure your tool is working as expected.

What is Codacy

Codacy is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.

Among Codacy’s features

  • Identify new Static Analysis issues
  • Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
  • Auto-comments on Commits and Pull Requests
  • Integrations with Slack, HipChat, Jira, YouTrack
  • Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories

Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.

Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.

Free for Open Source

Codacy is free for Open Source projects.