forked from phoedos/pmd
48 lines
2.9 KiB
Markdown
48 lines
2.9 KiB
Markdown
# PMD
|
|
|
|
![PMD Logo](https://raw.githubusercontent.com/pmd/pmd/pmd/7.0.x/docs/images/logo/pmd-logo-300px.png)
|
|
|
|
[![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)
|
|
|
|
## About
|
|
|
|
**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 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.
|
|
|
|
## 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? -- <https://pmd.github.io/latest/>
|
|
|
|
## Source
|
|
|
|
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.
|
|
|
|
## Website
|
|
|
|
More information can be found on our [Website](https://pmd.github.io).
|