Merge branch 'site-integrations' into pmd/5.5.x
This commit is contained in:
Andreas Dangel
@@ -2,11 +2,9 @@
|
||||
<author email="dpeugh@users.sourceforge.net">David Dixon-Peugh</author>
|
||||
-->
|
||||
|
||||
IDE Integrations
|
||||
================
|
||||
# IDE Integrations
|
||||
|
||||
Summary
|
||||
-------
|
||||
## Summary
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
@@ -23,6 +21,13 @@ Summary
|
||||
<td><a href="http://tomcopeland.blogs.com/">Tom Copeland</a></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><a href="#Codacy">Codacy</a></td>
|
||||
<td></td>
|
||||
<td><a class="externalLink" href="https://github.com/codacy/codacy-pmdjava">github: codacy/codacy-pmdjava</a></td>
|
||||
<td>Codacy</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><a href="#Code_Guide">CodeGuide</a></td>
|
||||
<td></td>
|
||||
@@ -58,6 +63,13 @@ Summary
|
||||
<td>Andrei Lumianski</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Gradle</td>
|
||||
<td><a href="https://docs.gradle.org/current/userguide/pmd_plugin.html">Gradle: The PMD Plugin</a></td>
|
||||
<td><a href="https://github.com/gradle/gradle/tree/master/subprojects/code-quality">github: gradle/gradle</a></td>
|
||||
<td><a href="https://gradle.org/">Gradle.org</a></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><a href="#IDEA">IntelliJ IDEA</a></td>
|
||||
<td></td>
|
||||
@@ -136,23 +148,25 @@ Summary
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
General comments
|
||||
----------------
|
||||
## General comments
|
||||
|
||||
A general note - most plugins include the PMD jar file, which has the rulesets
|
||||
A general note - most plugins include the PMD jar files, 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.
|
||||
use (i.e., "rulesets/java/unusedcode.xml") looks like a filesystem reference, it's really
|
||||
being used by a getResourceAsStream() call to load it out of the PMD jar files.
|
||||
|
||||
BlueJ
|
||||
-----
|
||||
## BlueJ
|
||||
|
||||
[BlueJ](http://bluej.org/) is a teaching IDE. To install the PMD extension for BlueJ, download
|
||||
the [PMDExtension jar file](http://sourceforge.net/projects/pmd/files/pmd-bluej/pmd-bluej-1.0/)
|
||||
and place it in your `bluej/lib/extensions/` directory.
|
||||
|
||||
Code Guide
|
||||
----------
|
||||
## Codacy
|
||||
|
||||
Although it is not an IDE, with [Codacy](https://www.codacy.com/) you have PMDJava analysis out-of-the-box,
|
||||
and it is free for open source projects.
|
||||
|
||||
## Code Guide
|
||||
|
||||
Here's how to set up PMD with Omnicore's CodeGuide:
|
||||
|
||||
@@ -176,8 +190,7 @@ 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](http://www.omnicore.com/).
|
||||
It's a great IDE.
|
||||
|
||||
Eclipse
|
||||
-------
|
||||
## Eclipse
|
||||
|
||||
To install the PMD plugin for Eclipse:
|
||||
|
||||
@@ -208,16 +221,14 @@ try deleting the ruleset.xml file in the .metadata/plugins/net.sourceforge.pmd.e
|
||||
To get Eclipse to not flag the @SuppressWarnings("PMD") annotation, look
|
||||
under the menu headings Java -> Compiler -> Errors/Warnings -> Annotations -> Unhandled Warning Token.
|
||||
|
||||
Emacs
|
||||
-----
|
||||
## Emacs
|
||||
|
||||
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.
|
||||
|
||||
Gel
|
||||
---
|
||||
## Gel
|
||||
|
||||
Here's how to set up the Gel plugin:
|
||||
|
||||
@@ -236,8 +247,7 @@ a configuration panel will pop up. You can pick which ruleset you want to run a
|
||||
you can also pick whether you want to run PMD on the current file or on every
|
||||
source file in your project.
|
||||
|
||||
IDEA
|
||||
----
|
||||
## IDEA
|
||||
|
||||
You can use an integrated plugin or just use it as an IDEA "External Tool".
|
||||
|
||||
@@ -265,8 +275,7 @@ be displayed in a window and hyperlinked into the correct file and line of code.
|
||||
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.
|
||||
|
||||
IDEA - QAPlug
|
||||
-------------
|
||||
## IDEA - QAPlug
|
||||
|
||||
QAPlug is an Intellij IDEA plugin to manage code quality. It integrates no less than Checkstyle, FindBugs, and PMD.
|
||||
|
||||
@@ -275,8 +284,7 @@ The plugin is available at <http://www.qaplug.com/>.
|
||||
Also available at the JetBrains site, [QAPlug-PMD](http://plugins.intellij.net/plugin/?idea_ce&id=4596)
|
||||
and [QAPlug](http://plugins.intellij.net/plugin/?idea_ce&id=4594).
|
||||
|
||||
JBuilder
|
||||
--------
|
||||
## JBuilder
|
||||
|
||||
To enable this OpenTool in JBuilder:
|
||||
|
||||
@@ -301,8 +309,7 @@ Things still to do:
|
||||
* Optional insertion of @todo comments at the point of a violation
|
||||
* Possibly provide configurable ability to limit the number of violations per rule per file
|
||||
|
||||
JCreator
|
||||
--------
|
||||
## JCreator
|
||||
|
||||
1. Open Configure > Options
|
||||
2. Go to the Tools panel
|
||||
@@ -315,8 +322,7 @@ JCreator
|
||||
|
||||
To run PMD on a project, just pick pmd from the Tools menu.
|
||||
|
||||
JDeveloper
|
||||
----------
|
||||
## JDeveloper
|
||||
|
||||
To install the PMD plugin for JDeveloper:
|
||||
|
||||
@@ -340,8 +346,7 @@ To run the PMD plugin for JDeveloper:
|
||||
Toolbar Icon, Context Menu or File Menu
|
||||
* Any rule violations should show up in a LogWindow tab at the bottom of the screen
|
||||
|
||||
JEdit
|
||||
-----
|
||||
## JEdit
|
||||
|
||||
The way I use the JEdit plugin is:
|
||||
|
||||
@@ -355,26 +360,22 @@ Note that you can select individual rules by going to Utilities->Global Options-
|
||||
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.
|
||||
|
||||
Maven
|
||||
-----
|
||||
## Maven
|
||||
|
||||
Please see [the Maven plugins web site](http://maven.apache.org/maven-1.x/plugins/pmd/) for more information.
|
||||
|
||||
Maven 2
|
||||
-------
|
||||
## Maven 2
|
||||
|
||||
Please see
|
||||
[the Maven 2 plugin web site](http://maven.apache.org/plugins/maven-pmd-plugin/index.html)
|
||||
for more information.
|
||||
Also, the bug tracker for this plugin is [here](http://jira.codehaus.org/browse/MPMD).
|
||||
|
||||
NetBeans
|
||||
--------
|
||||
## NetBeans
|
||||
|
||||
The [SQE](http://kenai.com/projects/sqe/) project includes PMD integration for NetBeans.
|
||||
|
||||
TextPad
|
||||
-------
|
||||
## TextPad
|
||||
|
||||
**Assumptions**
|
||||
|
||||
@@ -449,8 +450,7 @@ TextPad
|
||||
the (blank Command Results) document, and then confirming that, "yes, I do really want to exit the tool".</em>
|
||||
|
||||
|
||||
WebLogic Workshop 8.1.x
|
||||
-----------------------
|
||||
## WebLogic Workshop 8.1.x
|
||||
|
||||
Please see [the WebLogic Workshop plugin project home page](http://pmdwlw.sf.net/) for more information.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user