IDE | CVS Module | Maintainers |
Eclipse | pmd-eclipse | Philippe Herlin |
Emacs | pmd-emacs | Nascif Abousalh-Neto |
JBuilder | pmd-jbuilder | Dave Craine |
NetBeans/Sun ONE Studio | pmd-netbeans | Ole-Martin Mork, Gunnlaugur Thor Briem |
JEdit | pmd-jedit | Jiger Patel |
jDeveloper | pmd-jdeveloper | Tom Copeland |
Maven | N/A | Vincent Massol |
Gel | pmd-gel | Andrei Lumianski |
TextPad | N/A | Jeff Epstein |
Omnicore's CodeGuide | N/A | Austin Moore |
JCreator | N/A | Brant Gurganus |
IntelliJ IDEA | N/A | Tom Copeland |
Ant | N/A | Tom Copeland |
A general note - most plugins include the PMD jar file, which has the rulesets inside it. So even though the rulesets parameter that some plugins use (i.e., "rulesets/unusedcode.xml") looks like a filesystem reference, it's really being used by a getResourceAsStream() call to load it out of the PMD jar file.
Integration into Eclipse is accomplished through the extensive Plugin architecture provided by Eclipse. It is written in Java, and has some nice features to it.
Eclipse Integration will fill the TODO list of the project with each Rule Violation that PMD detects. These violations are marked in the code with the Task icon on the left hand side of the editor.
The Eclipse integration was written with the version 2.0 of Eclipse, so I'm not certain if it will work on earlier versions.
As Eclipse is not my primary IDE, we are looking for people who can make suggestions, and possibly even handle the care and feeding of the Eclipse plugin.
Integration with GNU Emacs is performed through an ELisp package, pmd.el. It supports two commands, "pmd-current-buffer" and "pmd-current-dir". The output is captured in a compilation buffer which allows the user to "jump" directly to the source code position associated with the PMD warnings.
To enable this OpenTool in JBuilder, place the PMDOpenTool.jar file AND the pmd-x.x.jar file (where x.x is the version id) into JBuilder's lib/ext directory. Once JBuilder is restart, the PMD OpenTool will be enabled. What you can do:
When running PMD, the results will be displayed in the MessageView under a tab called PMD Results. If you click on a violation message within this view, you will be taken to the line in the source code where the violation was detected.
Things still to do:
The way I use the JEdit plugin is:
Note that you can select individual rules by going to Utilities->Global Options->Plugin Options->PMD. Also, you can change the plugin to prompt you for a directory to check by going to that same menu and selecting the "Ask for Directory" checkbox.
Here's how to set up the PMD-Gel plugin:
That's pretty much it. Now you can open a Java project and click on Plugins->PMD and a configuration panel will pop up. You can pick which ruleset you want to run and you can also pick whether you want to run PMD on the current file or on every source file in your project.
Note that the source code needs to be compilable before PMD can check it.
D:\java\jdk_131\
. This means that D:\java\jdk_131\bin\java.exe
exists.D:\java\pmd-3.1\
. This means that D:\java\pmd-3.1\lib\pmd-3.1.jar
(among other jar files in the same directory) exist.D:\java\jdk_131\bin\java.exe
and click the Open button. In the center pane of the Preferences dialog, an item "Java" has now been added, and is currently selected.+
' directly to its left.-classpath D:\java\pmd-3.1\lib\pmd-3.1.jar;D:\java\pmd-3.1\lib\jaxen-core-1.0-fcs.jar; D:\java\pmd-3.1\lib\saxpath-1.0-fcs.jar;D:\java\pmd-3.1\lib\xmlParserAPIs-2.6.2.jar; D:\java\pmd-3.1\lib\xercesImpl-2.6.2.jar net.sourceforge.pmd.PMD $FileDir net.sourceforge.pmd.renderers.TextPadRenderer E:\directory\my_pmd_ruleset.xml -debug
jaxen-core-1.0-fcs.jar;
' and 'xmlParserAPIs-2.6.2.jar;
'. They are there to prevent the text from exceeding the right side of your screen)$FileDir
Checked
Checked
^\([^(]+\)(\([0-9]+\),
1
2
$FileDir
' with '$File
', in the Parameters textbox.E:\directory\my_pmd_ruleset.xml
' with the ruleset of your choice. For example, rulesets/basic.xml
.Ctrl+Page Up
Ctrl+Page Down
Ctrl+Page Down
. This opens an empty, read-only text document (titled "Command Results"). When PMD completes its analysis, this document will be populated with a listing of violated rules (or "Command completed successfully" indicating no violations).Ctrl+Page Up
. This opens an empty, read-only text document (titled "Command Results"). When PMD completes its analysis, this document will be populated with a listing of violated rules (or "Command completed successfully" indicating no violations).Because directory analysis may take a while, you may choose to cancel this operation. Do so by closing the (blank Command Results) document, and then confirming that, "yes, I do really want to exit the tool".
Here's how to set up PMD with Omnicore's CodeGuide (taken from here):
Now you can right click on a source directory, select the PMD tool and a dialog box will appear. Type in the name of a rule set (e.g. unusedcode). PMD is then executed on the directory you selected with the rule set you specified. Since CodeGuide understands the emacs syntax you can click on the file name and CodeGuide will jump to that file and line number.
Note: I set this up on Mac OS X. It should work on other unix variations just the same. Of course you need to change the "Executable" setting above to where your PMD is installed. On Windows you need to use the pmd.bat file instead of pmd.sh.
If you haven't heard of CodeGuide before, check it out. It's a great IDE.
There's not a "real" - i.e., integrated into the same Java VM - plugin for IDEA, but using it as an IDEA "External Tool" works OK. Here's how to set it up:
That's pretty much it. Now you can right click on a source directory and select PMD, it'll run recursively on the source files, and the results should be displayed in a window and hyperlinked into the correct file and line of code. I usually right-click on the message window title bar and unselect "autohide" so the window doesn't go away every time I fix something in the code window.
To install the jDeveloper plugin, download the binary release and unzip it into your jdev/lib/ext directory. Then restart jDeveloper. To use it, open the Tools-&Preferences menu, click on the PMD option, and select a couple of rules to try. To run it, right click on either a Java source file or a .jpr file (i.e., a project file) and select PMD. Any rule violations should show up in a LogWindow at the bottom of the screen.
Using PMD with Ant is such a standard usage that we hardly think of it as an integration point. But, I guess it is. You can read more about the PMD Ant task here.
To run PMD on a project, just pick pmd from the Tools menu.