vscode Apex Pmd

Allows you to run Apex Static Analysis directly in vscode on apex & visualforce files.

Features

Current actions Supported

Run analysis on file open
Run analysis on file save
Run analysis on entire workspace
Run analysis on single file
Ability to define your own ruleset

System Requirements

Must have JRE >= 1.7 installed and in path
See PMD System Requirements for more details

Configuration

rulesets (optional): set to override default ruleset (see "Defining your own ruleset" for more details)
runOnFileOpen: run every time a file is opened in vscode
runOnFileSave: run every time a file is saved
priorityErrorThreshold: Determines at what priority level 'errors' will be added. Anything less will be a warning or hint
priorityWarnThreshold: Determines at what priority level 'warnings' will be added. Anything less will be a hint
enableCache: Creates a cache file for PMD to run faster. Will create a .pmdCache file in your workspace
pmdBinPath (prev. pmdPath) (optional): set to override the default pmd binaries. This should point to the PMD folder which contains folders lib and bin. Most likely it is called libexec.

Defining your own "Ruleset"

I recommend you use the default ruleset as a starting point.

Set apexPMD.rulesets string array to reference your custom rulesets. You can either use the absolute paths, or a relative paths from your workspace (EG my-apex-rules.xml).

You can also mention the default ruleset in apexPMD.rulesets. To do this add default value to the array.

Apex Ruleset Reference

NOTE: If you are move alway from the "default result" in an sfdx project, make sure to exclude the .sfdx generated classes by keeping this line:

<exclude-pattern>.*/.sfdx/.*</exclude-pattern>

Legal Stuff

Copyright (c) 2003-2009, InfoEther, LLC
All rights reserved.

This product includes software developed in part by support from
the Defense Advanced Research Project Agency (DARPA)

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The full license (BSD-style) can be found in the PMD repo

ChouTH / vscode-apex-pmd