sf scanner rule describe (Retired)

Provides detailed information about a rule. Information includes the rule's language (such as Apex or Java), the violation it detects, and example code of the violation. The command output also includes the rule's categories and rulesets.

Example

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

Replace this value:

• {ExampleRule}: The name of the rule to describe.

Usage

sf scanner rule describe

   -n RULENAME

   [--json]

   [--verbose]

Flags

-n <b>|</b> --rulename RULENAME

Required

The name of the rule.

Type: option

--json

Optional

Format output as JSON.

Type: boolean

--verbose

Optional

Emit additional command output to stdout.

Type: boolean