https://github.com/codacy/codacy-pmd
PMD Tool for Codacy
https://github.com/codacy/codacy-pmd
codacy codacy-pmdjava codacy-tool docker docker-image hacktoberfest java pmd review tool
Last synced: 4 months ago
JSON representation
PMD Tool for Codacy
- Host: GitHub
- URL: https://github.com/codacy/codacy-pmd
- Owner: codacy
- License: other
- Created: 2015-07-20T09:53:16.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T18:35:51.000Z (9 months ago)
- Last Synced: 2025-09-29T20:03:04.127Z (4 months ago)
- Topics: codacy, codacy-pmdjava, codacy-tool, docker, docker-image, hacktoberfest, java, pmd, review, tool
- Language: Java
- Homepage:
- Size: 4.41 MB
- Stars: 2
- Watchers: 18
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.codacy.com/gh/codacy/codacy-pmd?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-pmd&utm_campaign=Badge_Grade)
[](https://circleci.com/gh/codacy/codacy-pmd)
# Codacy PMD
This is the docker engine we use at Codacy to have [pmd](https://pmd.github.io/) 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
```
##### Docker Image Versioning
Repository Branch | Docker Image
--- | ---
master | codacy-pmd
pmd-legacy | codacy-pmdjava
#### Run the docker
```
docker run --user=docker --rm=true -v :/src -v /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 `toolVersionKey` in `build.sbt`
2. Run the DocGenerator
```sh
sbt "runMain com.codacy.pmd.DocGenerator"
```
## Docs
[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)
[Tool Developer Guide - Using Scala](https://support.codacy.com/hc/en-us/articles/207280379-Tool-Developer-Guide-Using-Scala)
## Test
We use the [codacy-plugins-test](https://github.com/codacy/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](https://www.codacy.com/) 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.