Repository files navigation

codeclimate-pmd is a Code Climate engine that wraps thePMD static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.

1. If you haven't already,install the Code Climate CLI.
2. Runcodeclimate engines:enable pmd. This command both installs the engine and enables it in your.codeclimate.yml file.
3. You're ready to analyze! Browse into your project's folder and runcodeclimate analyze.
4. To add you custom PMD rules, open.codeclimate.yml and add aconfig entry pointing to yourruleset.xml file:

engines:pmd:enabled:trueconfig:ruleset.xml

For help with PMD,check out their documentation.

If you're running into a Code Climate issue, first check outour PMD engine docs and look over this project'sGitHub Issues,as your question may have already been covered. If not,go ahead and open a support ticket with us.