Rule command
Prints the explanation for a given validation rule. Many check diagnostics carry a
rule name (e.g. error (type-error)) that can be looked up with this command. Each
rule’s documentation contains the languages the rule applies to, the specification
passage it enforces, and annotated examples with fixes.
The full rule list is available at Validation rules.
Basic usage
List all rules available in Syside:
syside rule list
Explain one or more rules by name:
syside rule type-error
The explanation is printed as Markdown.
Available options
Option |
Description |
|---|---|
|
Display the help message with all available flags and short descriptions |
|
Explain all rules. Cannot be combined with rule names |
|
Output format: |