Salesforce Code Analyzer Command Reference

Salesforce Code Analyzer Command Reference

Contents




sfdx scanner:rule:describe

Provides detailed information about a rule. Information includes its description, language (such as Apex or Java) and the error message that user can expect if this rule violation occurs. The command output also includes the rule’s categories and rulesets.

Usage

$ sfdx scanner:rule:describe -n <string> [--verbose] [--json]

Options

  -n, --rulename=rulename	(required) The name of the rule.
  --json			Format output as json
  --verbose 			Emit additional command output to stdout

Example

  $ sfdx scanner:rule:describe --rulename ExampleRule
     name:        ExampleRule
     categories:  ExampleCategory
     rulesets:    Ruleset1
                  Ruleset2
                  Ruleset3
     languages:   apex
     description: Short description of rule
     message:     ExampleRule Violated.

Demo

Describe Example

Feedback or Bugs | Edit this Article