sprocket explain ​

The sprocket explain command describes lint and validation rules. It can explain one rule, list rules by tag, or print the definitions used in rule documentation.

For a browsable list of every rule, see the lint and validation rule reference. To select, suppress, or baseline rules when checking WDL, see sprocket check and sprocket lint.

Usage ​

Sprocket 0.31.0 supports these forms:

sprocket explain <RULE>
sprocket explain --tag <TAG>
sprocket explain --definitions
sprocket explain --list-all-rules
sprocket explain --list-all-tags

Use --format json when another program needs to consume the result. For example, this returns an array of rule objects:

sprocket explain --list-all-rules --format json

The command also accepts Sprocket's common logging, color, ignore, and configuration options. Run sprocket explain --help for the complete list.

Explain one rule ​

For example, ImportPlacement explains where import statements belong and shows both the reported code and its revision:

sprocket explain ImportPlacement

ImportPlacement [Clarity]
Ensures that imports are placed between the version statement and any document items.

All import statements should follow the WDL version declaration with one empty line between the version and the first import statement.

Examples:
```wdl
version 1.2

workflow example {
}

import "example2.wdl"
```
Use instead:

```wdl
version 1.2

import "example2.wdl"

workflow example {
}
```

List tags ​

Use --list-all-tags to see the tags accepted by --tag:

sprocket explain --list-all-tags

Available tags:
  - All
  - Clarity
  - Completeness
  - Correctness
  - Deprecated
  - Documentation
  - Naming
  - Performance
  - Portability
  - Sorting
  - Spacing
  - SprocketCompatibility
  - Style