diff --git a/pmd/xdocs/integrations.xml b/pmd/xdocs/integrations.xml index 58ebef0d99..5dbef421e7 100644 --- a/pmd/xdocs/integrations.xml +++ b/pmd/xdocs/integrations.xml @@ -125,9 +125,78 @@ you can change the plugin to prompt you for a directory to check by going to tha selecting the "Ask for Directory" checkbox.

- -

Please see the Maven plugins web site for more information.

- + + +

Please see the Maven plugins web site for more information.

+ + + + +
Assumptions
+ +

+ +
To integrate into TextPad
+ +

    +
  1. In the Configure menu, choose Preferences.... This opens the Preferences dialog
    2. +
  2. In the left pane of the Preferences dialog, choose the Tools branch by clicking on the word "Tools".
    3. +
  3. On the far right of the dialog, click on the Add button, and then select Program... from the drop-down. This opens the standard Windows Open File dialog.
    4. +
  4. Type 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.
    5. +
  5. Click the word Java, which makes the word editable. Select the entire word, and type "PMD directory". Press Return
    6. +
  6. Repeat steps three through five, but type "PMD file", instead of "PMD directory".
    7. +
  7. Click Apply.
    8. +
  8. Expand the Tools branch (if not already) by clicking on the '+' directly to its left.
    9. +
  9. In the expanded list, select PMD directory. This changes the right side of this dialog to the "tool" form.
    10. +
  10. In the "tool" form, enter these parameters:
      +
    • Parameters: -classpath D:\java\pmd-1.2.1\lib\pmd-1.2.1.jar;D:\java\pmd-1.2.1\lib\jaxen-core-1.0-fcs.jar; D:\java\pmd-1.2.1\lib\saxpath-1.0-fcs.jar;D:\java\pmd-1.2.1\lib\xmlParserAPIs-2.0.2.jar; D:\java\pmd-1.2.1\lib\xercesImpl-2.0.2.jar net.sourceforge.pmd.PMD $FileDir net.sourceforge.pmd.renderers.TextPadRenderer E:\directory\my_pmd_ruleset.xml -debug +
      (Eliminate the spaces following both 'jaxen-core-1.0-fcs.jar;' and 'xmlParserAPIs-2.0.2.jar;'. They are there to prevent the text from exceeding the right side of your screen)
      • +
    • Initial Folder: $FileDir
      • +
    • Save all documents first: Checked
      • +
    • Capture output: Checked
      • +
    • All other checkboxes: Unchecked
      • +
    • Regular expression to match output: ^\([^(]+\)(\([0-9]+\),
      • +
    • Registers/File: 1
      • +
    • Registers/Line: 2
      • +
    11. +
  11. In the expanded list, select PMD file.
    12. +
  12. In the "tool" form, enter the same parameters as above, except replace '$FileDir' with '$File', in the Parameters textbox.
    13. +
  13. To save your work (truly, given a quirk of TextPad), click on OK, which closes the Preferences dialog. Restart TextPad and re-open the Preferences dialog.
    14. +
  14. Go back to both the "PMD directory" and "PMD file" Tools branches, and replace 'E:\directory\my_pmd_ruleset.xml' with the ruleset of your choice. For example, rulesets/basic.xml.
    15. +
  15. Go to the Keyboard branch in the left pane (above Tools), which changes the right side to the "keyboard configuration" form.
    16. +
  16. In the Categories list box, select Tools.
    17. +
  17. In the Command list box, select PMD directory.
    18. +
  18. Put your cursor into the Press new shortcut key, and type your desired key command. For example Ctrl+Page Up
    19. +
  19. Click Assign.
    20. +
  20. In the Command list box, select PMD file.
    21. +
  21. Put your cursor into the Press new shortcut key, and type your desired key command. For example Ctrl+Page Down
    22. +
  22. Click Assign.
    23. +
  23. Save your work again: Click on OK, which closes the Preferences dialog, and then restart TextPad.
    24. +

+ + +
To run PMD against a single Java file
+ +

    +
  1. In TextPad, open any Java file.
    2. +
  2. Click 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).
    3. +
  3. Double click any line to go to it.
    4. +

+ +
To run PMD against a directory of Java files
+ +

    +
  1. In TextPad, open any file in the root directory you wish to analyze. Unfortunately, you'll need to create a dummy file, if no file exists there.
    2. +
  2. Click 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).
    3. +
  3. Double click any line to go to it.
    4. +

+ +

Because directory analysis may take a while, you may choose to cancel this operation. Do so by closing the (black Command Results) document, and then confirming that, "yes, I do really want to exit the tool".

+ +

Here's how to set up the PMD-Gel plugin: