PMD Java Tool for Codacy
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
project
src/main
.gitignore
LICENSE
README.md
build.sbt

README.md

Codacy Badge Build Status

Codacy PMDJava

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

Usage

Publish the docker

sbt 'set version in Docker := "dev"' 'set name := "pmd"' docker:publishLocal

Run the docker

docker run --user=docker --rm=true -v <PATH-TO-CODE>:/src -v <PATH-TO>/ruleset.xml:/src/ruleset.xml codacy/pmd:dev

Make sure all the volumes mounted have the right permissions for user docker

Generate Docs

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

  2. Run the DocGenerator

sbt "run-main codacy.pmd.DocGenerator [<VERSION>]"

Docs

Tool Developer Guide

Tool Developer Guide - Using Scala

Test

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.