Repository files navigation

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables,empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned withJava andApex, butsupports 16 other languages. It comes with400+ built-in rules. It can beextended 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.

Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce,Kotlin, Swift, Modelica, PLSQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL.Scala is supported, but there are currently no Scala rules available.

Additionally, it includesCPD, the copy-paste-detector. CPD finds duplicated code inCoco, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin,Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex andVisualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

Download the latest binary zip from thereleasesand extract it somewhere.

Executebin/pmd check orbin\pmd.bat check.

See alsoGetting Started

Demo:

This shows how PMD analysesopenjdk:

There are plugins for Maven and Gradle as well as for various IDEs.SeeTools / Integrations

• How do I? -- Ask a question onStackOverflowor ondiscussions.
• I got this error, why? -- Ask a question onStackOverflowor ondiscussions.
• I got this error and I'm sure it's a bug -- file anissue.
• I have an idea/request/question -- create a newdiscussion.
• I have a quick question -- ask in ourGitter roomor ourPMD Guru at Gurubase.
• Where's your documentation? --https://docs.pmd-code.org/latest/

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 onGitHub. Fork us!

For details, seeHow to contribute to PMD.

The rule designer is developed over atpmd/pmd-designer.Please seeits README fordeveloper documentation.

Become a financial contributor and help us sustain our community.Contribute

This project follows theall-contributors specification.Contributions of any kind welcome!

Seecredits for the complete list.

BSD Style