Reference
Lint rules
Every built-in rule with its options, default severity, and preset membership.
Generated from the rule metadata of the installed package. Configure a rule with "error", "warning", "off", or [severity, options].
| Rule | Default severity | Recommended | Default options | Checks |
|---|---|---|---|---|
token-name-length | warning | \{\} | Token names must be within a length range. | |
group-name-length | warning | \{\} | Group names must be within a length range. | |
description-length | warning | \{\} | $description text must be within a length range. | |
naming-convention | warning | \{\} | Token and group names follow a naming style (kebab, camel, pascal, snake, or a custom pattern). | |
require-description | warning | Every token has a $description. | ||
require-explicit-type | warning | Every token declares its own $type instead of inheriting it. | ||
max-alias-depth | warning | ✔ | \{"max":5\} | Alias chains resolve within a maximum number of hops. |
no-unused-tokens | warning | ✔ | \{"ignore":[]\} | Every token is referenced by at least one alias or $ref, except those matched by ignore patterns. |
no-deprecated-alias | warning | ✔ | Tokens do not alias deprecated tokens. | |
no-empty-groups | warning | ✔ | Groups contain at least one token or sub-group. | |
extensions-allowed-vendors | warning | \{"vendors":[]\} | Only listed vendor keys may appear in $extensions. | |
extensions-schema | error | \{"vendors":\{\}\} | Vendor blocks in $extensions match a declared shape. |
See Linting for configuration and Writing custom rules for the rule API.