{"id":19359769,"url":"https://github.com/codacy/codacy-pmd","last_synced_at":"2025-10-09T02:42:23.391Z","repository":{"id":42471514,"uuid":"39376168","full_name":"codacy/codacy-pmd","owner":"codacy","description":"PMD Tool for Codacy","archived":false,"fork":false,"pushed_at":"2025-04-17T18:35:51.000Z","size":4624,"stargazers_count":2,"open_issues_count":0,"forks_count":6,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-09-29T20:03:04.127Z","etag":null,"topics":["codacy","codacy-pmdjava","codacy-tool","docker","docker-image","hacktoberfest","java","pmd","review","tool"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codacy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-20T09:53:16.000Z","updated_at":"2025-04-17T18:24:31.000Z","dependencies_parsed_at":"2023-01-21T11:31:05.864Z","dependency_job_id":"13961531-cd0f-4112-a447-603a488ccb2e","html_url":"https://github.com/codacy/codacy-pmd","commit_stats":null,"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"purl":"pkg:github/codacy/codacy-pmd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-pmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-pmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-pmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-pmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codacy","download_url":"https://codeload.github.com/codacy/codacy-pmd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-pmd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000773,"owners_count":26082906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codacy","codacy-pmdjava","codacy-tool","docker","docker-image","hacktoberfest","java","pmd","review","tool"],"created_at":"2024-11-10T07:16:05.227Z","updated_at":"2025-10-09T02:42:23.346Z","avatar_url":"https://github.com/codacy.png","language":"Java","readme":"[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d0f04e048bba4a01a7ef0166bf5b8d32)](https://www.codacy.com/gh/codacy/codacy-pmd?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=codacy/codacy-pmd\u0026amp;utm_campaign=Badge_Grade)\n[![Build Status](https://circleci.com/gh/codacy/codacy-pmd.svg?style=shield\u0026circle-token=:circle-token)](https://circleci.com/gh/codacy/codacy-pmd)\n\n# Codacy PMD\n\nThis is the docker engine we use at Codacy to have [pmd](https://pmd.github.io/) support.\nYou can also create a docker to integrate the tool and language of your choice!\nCheck the **Docs** section for more information.\n\n## Usage\n\n#### Publish the docker\n\n```\nsbt 'set version in Docker := \"dev\"' 'set name := \"pmd\"' docker:publishLocal\n```\n\n##### Docker Image Versioning\n\nRepository Branch | Docker Image\n--- | ---\nmaster | codacy-pmd\npmd-legacy | codacy-pmdjava\n\n#### Run the docker\n\n```\ndocker run --user=docker --rm=true -v \u003cPATH-TO-CODE\u003e:/src -v \u003cPATH-TO\u003e/ruleset.xml:/src/ruleset.xml codacy/pmd:dev\n```\n\u003e Make sure all the volumes mounted have the right permissions for user `docker`\n\n#### Generate Docs\n\n1. Update `toolVersionKey` in `build.sbt`\n\n2. Run the DocGenerator\n```sh\nsbt \"runMain com.codacy.pmd.DocGenerator\"\n```\n\n## Docs\n\n[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)\n\n[Tool Developer Guide - Using Scala](https://support.codacy.com/hc/en-us/articles/207280379-Tool-Developer-Guide-Using-Scala)\n\n## Test\n\nWe use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.\nYou can follow the instructions there to make sure your tool is working as expected.\n\n## What is Codacy?\n\n[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.\n\n### Among Codacy’s features:\n\n - Identify new Static Analysis issues\n - Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)\n - Auto-comments on Commits and Pull Requests\n - Integrations with Slack, HipChat, Jira, YouTrack\n - Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories\n\nCodacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.\n\nCodacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.\n\n### Free for Open Source\n\nCodacy is free for Open Source projects.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-pmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodacy%2Fcodacy-pmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-pmd/lists"}