jefersonchaves / vscode-apex-pmd

PMD static analysis for Apex in vscode

vscode Apex Pmd

Allows you to run Apex Static Analysis directly in vscode on Apex, VisualForce & other XML metadata files.

Features

Current actions Supported

• Run analysis on file open
• Run analysis on file save
• Run analysis on file change (new!)
• Run analysis on entire workspace
• Run analysis on single file
• Ability to define your own ruleset

System Requirements

• Must have JRE >= 1.8 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
• runOnFileChange: Run when a file is changed. NOTE: this is "debounced" to prevent performance issues. Delay can be adjusted via onFileChangeDebounce.
• 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.
• additionalClassPaths (optional): set of paths to be appended to classpath. Used to find jar files containing custom rule definitions. Can be absolute or relative to workspace.
• commandBufferSize Size of buffer used to collect PMD command output (MB), may need to be increased for very large projects
• jrePath (Optional) Path to JRE (Folder that contains which contains bin/java)

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 move away from the default ruleset in an sfdx project, make sure to exclude the .sfdx generated classes by keeping this line:

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

Using custom rules written in Java

If you want to use your own custom rules from a jar file, then the jar file must be on the classpath. By default, the PMD folder and the workspace root folder are included in the classpath. You can add further folders using the additionalClassPaths setting. This "Hello world" example is a good starting place for beginners.

Developing/Contributing

Setup & Run

1. git clone
2. npm install
3. debug -> "launch extension"

Upgrading PMD

npm run update-pmd

Any pull request submitted with updates to PMD MUST BE "CHECKSUMED"!

Legal Stuff

Copyright (c) 2020 Charles Jonas and Contributors

PMD License

Contains Distribution of PMD library.

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