ryl

ryl, a fast YAML linter written in Rust

Type object
File match ryl.toml .ryl.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ryl/latest.json
Source https://www.schemastore.org/ryl.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON Schema root for ryl TOML configuration.

Properties

fix FixTable | null

Native fix policy, available only in TOML config.

ignore StringOrVec | null

Ignore patterns, either as one multi-line string or a list of patterns.

ignore-from-file StringOrVec | null

Paths to files that contain ignore patterns.

locale string | null

Locale identifier used by diagnostics.

rules RulesTable | null

Rule configuration table.

yaml-files array | null

Glob patterns used to identify YAML files while scanning directories.

Definitions

FixRuleName string

A fixable rule name accepted by fix.unfixable.

FixTable object

TOML [fix] table.

fixable array | null
unfixable array | null
FixableRuleSelector string

A rule selector accepted by fix.fixable.

ForbidMode string
ForbidSetting boolean | ForbidMode
IndentSequencesMode string
IndentSequencesSetting boolean | IndentSequencesMode
NewLinesType string
QuoteType string
QuotedStringsRequired boolean | QuotedStringsRequiredMode
QuotedStringsRequiredMode string
RuleEntryForAnchorsOptions boolean | RuleSwitch | RuleOptionsForAnchorsOptions

Common rule entry shape used by TOML config.

RuleEntryForBraceLikeOptions boolean | RuleSwitch | RuleOptionsForBraceLikeOptions

Common rule entry shape used by TOML config.

RuleEntryForColonsOptions boolean | RuleSwitch | RuleOptionsForColonsOptions

Common rule entry shape used by TOML config.

RuleEntryForCommasOptions boolean | RuleSwitch | RuleOptionsForCommasOptions

Common rule entry shape used by TOML config.

RuleEntryForCommentsOptions boolean | RuleSwitch | RuleOptionsForCommentsOptions

Common rule entry shape used by TOML config.

RuleEntryForDocumentPresenceOptions boolean | RuleSwitch | RuleOptionsForDocumentPresenceOptions

Common rule entry shape used by TOML config.

RuleEntryForEmptyLinesOptions boolean | RuleSwitch | RuleOptionsForEmptyLinesOptions

Common rule entry shape used by TOML config.

RuleEntryForEmptyValuesOptions boolean | RuleSwitch | RuleOptionsForEmptyValuesOptions

Common rule entry shape used by TOML config.

RuleEntryForFloatValuesOptions boolean | RuleSwitch | RuleOptionsForFloatValuesOptions

Common rule entry shape used by TOML config.

RuleEntryForHyphensOptions boolean | RuleSwitch | RuleOptionsForHyphensOptions

Common rule entry shape used by TOML config.

RuleEntryForIndentationOptions boolean | RuleSwitch | RuleOptionsForIndentationOptions

Common rule entry shape used by TOML config.

RuleEntryForKeyDuplicatesOptions boolean | RuleSwitch | RuleOptionsForKeyDuplicatesOptions

Common rule entry shape used by TOML config.

RuleEntryForKeyOrderingOptions boolean | RuleSwitch | RuleOptionsForKeyOrderingOptions

Common rule entry shape used by TOML config.

RuleEntryForLineLengthOptions boolean | RuleSwitch | RuleOptionsForLineLengthOptions

Common rule entry shape used by TOML config.

RuleEntryForNewLinesOptions boolean | RuleSwitch | RuleOptionsForNewLinesOptions

Common rule entry shape used by TOML config.

RuleEntryForNoOptions boolean | RuleSwitch | RuleOptionsForNoOptions

Common rule entry shape used by TOML config.

RuleEntryForOctalValuesOptions boolean | RuleSwitch | RuleOptionsForOctalValuesOptions

Common rule entry shape used by TOML config.

RuleEntryForQuotedStringsOptions boolean | RuleSwitch | RuleOptionsForQuotedStringsOptions

Common rule entry shape used by TOML config.

RuleEntryForTruthyOptions boolean | RuleSwitch | RuleOptionsForTruthyOptions

Common rule entry shape used by TOML config.

RuleLevel string

Rule severity override.

RuleOptionsForAnchorsOptions object

Common rule fields plus rule-specific options.

forbid-duplicated-anchors boolean | null
forbid-undeclared-aliases boolean | null
forbid-unused-anchors boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
RuleOptionsForBraceLikeOptions object

Common rule fields plus rule-specific options.

forbid ForbidSetting | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
max-spaces-inside integer | null
max-spaces-inside-empty integer | null
min-spaces-inside integer | null
min-spaces-inside-empty integer | null
RuleOptionsForColonsOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
max-spaces-after integer | null
max-spaces-before integer | null
RuleOptionsForCommasOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
max-spaces-after integer | null
max-spaces-before integer | null
min-spaces-after integer | null
RuleOptionsForCommentsOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
ignore-shebangs boolean | null
level RuleLevel | null
min-spaces-from-content integer | null
require-starting-space boolean | null
RuleOptionsForDocumentPresenceOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
present boolean | null
RuleOptionsForEmptyLinesOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
max integer | null
max-end integer | null
max-start integer | null
RuleOptionsForEmptyValuesOptions object

Common rule fields plus rule-specific options.

forbid-in-block-mappings boolean | null
forbid-in-block-sequences boolean | null
forbid-in-flow-mappings boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
RuleOptionsForFloatValuesOptions object

Common rule fields plus rule-specific options.

forbid-inf boolean | null
forbid-nan boolean | null
forbid-scientific-notation boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
require-numeral-before-decimal boolean | null
RuleOptionsForHyphensOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
max-spaces-after integer | null
RuleOptionsForIndentationOptions object

Common rule fields plus rule-specific options.

check-multi-line-strings boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
indent-sequences IndentSequencesSetting | null
level RuleLevel | null
spaces SpacesSetting | null
RuleOptionsForKeyDuplicatesOptions object

Common rule fields plus rule-specific options.

forbid-duplicated-merge-keys boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
RuleOptionsForKeyOrderingOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
ignored-keys array | null
level RuleLevel | null
RuleOptionsForLineLengthOptions object

Common rule fields plus rule-specific options.

allow-non-breakable-inline-mappings boolean | null
allow-non-breakable-words boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
max integer | null
RuleOptionsForNewLinesOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
type NewLinesType | null
RuleOptionsForNoOptions object

Common rule fields plus rule-specific options.

ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
RuleOptionsForOctalValuesOptions object

Common rule fields plus rule-specific options.

forbid-explicit-octal boolean | null
forbid-implicit-octal boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
RuleOptionsForQuotedStringsOptions object

Common rule fields plus rule-specific options.

allow-quoted-quotes boolean | null
check-keys boolean | null
extra-allowed array | null
extra-required array | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
quote-type QuoteType | null
required QuotedStringsRequired | null
RuleOptionsForTruthyOptions object

Common rule fields plus rule-specific options.

allowed-values array | null
check-keys boolean | null
ignore StringOrVec | null
ignore-from-file StringOrVec | null
level RuleLevel | null
RuleSwitch string

Shorthand rule enable/disable syntax.

RulesTable object

Built-in rule table for TOML config.

anchors RuleEntryForAnchorsOptions | null
braces RuleEntryForBraceLikeOptions | null
brackets RuleEntryForBraceLikeOptions | null
colons RuleEntryForColonsOptions | null
commas RuleEntryForCommasOptions | null
comments RuleEntryForCommentsOptions | null
comments-indentation RuleEntryForNoOptions | null
document-end RuleEntryForDocumentPresenceOptions | null
document-start RuleEntryForDocumentPresenceOptions | null
empty-lines RuleEntryForEmptyLinesOptions | null
empty-values RuleEntryForEmptyValuesOptions | null
float-values RuleEntryForFloatValuesOptions | null
hyphens RuleEntryForHyphensOptions | null
indentation RuleEntryForIndentationOptions | null
key-duplicates RuleEntryForKeyDuplicatesOptions | null
key-ordering RuleEntryForKeyOrderingOptions | null
line-length RuleEntryForLineLengthOptions | null
new-line-at-end-of-file RuleEntryForNoOptions | null
new-lines RuleEntryForNewLinesOptions | null
octal-values RuleEntryForOctalValuesOptions | null
quoted-strings RuleEntryForQuotedStringsOptions | null
trailing-spaces RuleEntryForNoOptions | null
truthy RuleEntryForTruthyOptions | null
SpacesMode string
SpacesSetting integer | SpacesMode
StringOrVec string | string[]

A TOML field that accepts either one string or a list of strings.

TruthyAllowedValue string