Salesforce Code Analyzer Command Reference

sfdx scanner:rule:add

Add custom rules to the Salesforce Code Analyzer’s registry to run them along with the built-in rules. Compile and test custom rules separately before adding them.

See Authoring Custom Rules for more information.

Usage

$ sfdx scanner:rule:add -l <string> -p <array> [--json]

Options

  -l, --language=language	(required) Language against which the custom rules will evaluate
  -p, --path=path		(required) One or more paths (such as a directory or JAR file) to custom rule definitions. Specify multiple values as a comma-separated list.
  --json			Format output as json

Example

Add XPath-only custom PMD rules as standalone XML files. Java-based rules must be bundled in JAR files. Be sure to adhere to PMD conventions, such as defining the custom rules in XML fils under a /category directory.

See the PMD documentation for information about writing rules.

This example shows how to specify two files directly.

$ sfdx scanner:rule:add --language apex --path "/Users/me/rules/Jar1.jar,/Users/me/rules/category/apex/MyRules.xml"
         Successfully added rules for apex.
         2 path(s) added:
         /Users/me/rules/Jar1.jar,/Users/me/rules/category/apex/MyRules.xml

This example shows how to specify a directory that contains one or more rule files, all of which are added to the registry.

$ sfdx scanner:rule:add --language apex --path "/Users/me/rules"
         Successfully added rules for apex.
         2 path(s) added:
         /Users/me/rules/SomeJar.jar,/Users/me/rules/category/apex/MyRules.xml

Demo

Feedback or Bugs | Edit this Article