# PMD - source code analyzer [![Join the chat at https://gitter.im/pmd/pmd](https://badges.gitter.im/pmd/pmd.svg)](https://gitter.im/pmd/pmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://github.com/pmd/pmd/workflows/build/badge.svg?branch=master)](https://github.com/pmd/pmd/actions) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd) [![Reproducible Builds](https://img.shields.io/badge/Reproducible_Builds-ok-green?labelColor=blue)](https://github.com/jvm-repo-rebuild/reproducible-central#net.sourceforge.pmd:pmd) [![Coverage Status](https://coveralls.io/repos/github/pmd/pmd/badge.svg)](https://coveralls.io/github/pmd/pmd) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a674ee8642ed44c6ba7633626ee95967)](https://www.codacy.com/app/pmd/pmd?utm_source=github.com&utm_medium=referral&utm_content=pmd/pmd&utm_campaign=Badge_Grade) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) [![Documentation (latest)](https://img.shields.io/badge/docs-latest-green)](https://pmd.github.io/latest/) **PMD** is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It supports many languages. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query. It supports Java, JavaScript, Salesforce.com Apex and Visualforce, Modelica, PLSQL, Apache Velocity, XML, XSL, Scala. Additionally it includes **CPD**, the copy-paste-detector. CPD finds duplicated code in C/C++, C#, Dart, Fortran, Go, Groovy, Java, JavaScript, JSP, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex, Scala, Swift, Visualforce and XML. In the future we hope to add support for data/control flow analysis and automatic (quick) fixes where it makes sense. ## πŸš€ Installation and Usage Download the latest binary zip from the [releases](https://github.com/pmd/pmd/releases/latest) and extract it somewhere. Execute `bin/run.sh pmd` or `bin\pmd.bat`. See also [Getting Started](https://pmd.github.io/latest/pmd_userdocs_installation.html) **Demo:** This shows how PMD can detect for loops, that can be replaced by for-each loops. ![Demo](docs/images/userdocs/pmd-demo.gif) There are plugins for Maven and Gradle as well as for various IDEs. See [Tools / Integrations](https://pmd.github.io/latest/pmd_userdocs_tools.html) ## ℹ️ How to get support? * How do I? -- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/pmd) or on [discussions](https://github.com/pmd/pmd/discussions). * I got this error, why? -- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/pmd) or on [discussions](https://github.com/pmd/pmd/discussions). * I got this error and I'm sure it's a bug -- file an [issue](https://github.com/pmd/pmd/issues). * I have an idea/request/question -- create a new [discussion](https://github.com/pmd/pmd/discussions). * I have a quick question -- ask on our [Gitter chat](https://gitter.im/pmd/pmd). * Where's your documentation? -- ## 🀝 Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Our latest source of PMD can be found on [GitHub](https://github.com/pmd/pmd). Fork us! * [How to build PMD](BUILDING.md) * [How to contribute to PMD](CONTRIBUTING.md) The rule designer is developed over at [pmd/pmd-designer](https://github.com/pmd/pmd-designer). Please see [its README](https://github.com/pmd/pmd-designer#contributing) for developer documentation. ## πŸͺ™ Financial Contributors Become a financial contributor and help us sustain our community. [Contribute](https://opencollective.com/pmd/contribute) ## ✨ Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0xflotus

πŸ’»

Akshat Bahety

πŸ’»

Alberto FernΓ‘ndez

πŸ’»

Alex Shesterov

πŸ’»

Anand Subramanian

πŸ’»

Anatoly Trosinenko

πŸ’»

Andi Pabst

πŸ’»

Andreas Dangel

πŸ’» πŸ“–

Andrey Mochalov

πŸ’»

Arnaud Jeansen

πŸ’»

Artem

πŸ’»

BBG

πŸ’» πŸ“–

Bhanu Prakash Pamidi

πŸ’»

BjΓΆrn Kautler

πŸ’»

Bolarinwa Saheed Olayemi

πŸ’»

Brice Dutheil

πŸ’»

Christofer Dutz

πŸ’»

Clint Chester

πŸ’»

ClΓ©ment Fournier

πŸ’» πŸ“–

Cyril

πŸ’»

Dale

πŸ’»

David BurstrΓΆm

πŸ’»

David Renz

πŸ’»

Denis Borovikov

πŸ’»

Dennie Reniers

πŸ’»

Dionisio CortΓ©s FernΓ‘ndez

πŸ’»

Filipe Esperandio

πŸ’»

Frits Jalvingh

πŸ’»

Gonzalo Exequiel Ibars Ingman

πŸ’»

Gunther Schrijvers

πŸ’»

Henning Schmiedehausen

πŸ’»

Henning von Bargen

πŸ’»

Hooperbloob

πŸ’»

IDoCodingStuffs

πŸ’»

Jan Aertgeerts

πŸ’»

Jeff Bartolotta

πŸ’»

Jeff Hube

πŸ’»

John-Teng

πŸ’»

Jon Moroney

πŸ’»

Jonathan Wiesel

πŸ’»

Joseph

πŸ’»

Josh Feingold

πŸ’»

JoΓ£o Ferreira

πŸ’»

Juan MartΓ­n Sotuyo Dodero

πŸ’» πŸ“–

Kirk Clemens

πŸ’»

Kris Scheibe

πŸ’»

Larry Diamond

πŸ’»

Lucas Soncini

πŸ’»

Machine account for PMD

πŸ’»

Maikel Steneker

πŸ’»

Manuel Moya Ferrer

πŸ’»

Mark Hall

πŸ’»

MatiasComercio

πŸ’»

MatΓ­as Fraga

πŸ’»

Maxime Robert

πŸ’»

Mykhailo Palahuta

πŸ’»

Olivier Parent

πŸ’»

Ollie Abbey

πŸ’»

Ozan Gulle

πŸ’»

Pelisse Romain

πŸ’» πŸ“–

Peter Chittum

πŸ’»

Philip Graf

πŸ’»

Piotrek Ε»ygieΕ‚o

πŸ’»

RajeshR

πŸ’»

Renato Oliveira

πŸ’»

Robbie Martinus

πŸ’»

Robert SΓΆsemann

πŸ’» πŸ“– πŸ“’

Robin Stocker

πŸ’»

Roman Salvador

πŸ’»

Sergey Yanzin

πŸ’»

Shubham

πŸ’»

TIOBE Software

πŸ’»

Techeira DamiΓ‘n

πŸ’»

Thomas Smith

πŸ’»

Thunderforge

πŸ’»

Tobias Weimer

πŸ’»

Tomi De Lucca

πŸ’»

Utku Cuhadaroglu

πŸ’»

William Brockhus

πŸ’»

XenoAmess

πŸ’»

Young Chan

πŸ’»

andrey81inmd

πŸ’»

astillich-igniti

πŸ’»

berkam

πŸ’»

dependabot[bot]

πŸ’»

gwilymatgearset

πŸ’»

hvbtup

πŸ’»

josemanuelrolon

πŸ’»

kabroxiko

πŸ’»

kenji21

πŸ’»

orimarko

πŸ’»

piotrszymanski-sc

πŸ’»

reudismam

πŸ’»

rmohan20

πŸ’»

ryan-gustafson

πŸ’»

sergeygorbaty

πŸ’»

sturton

πŸ’»

testation21

πŸ’»

xnYi9wRezm

πŸ’»

zgrzyt93

πŸ’»
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## πŸ“ License [BSD Style](LICENSE)