blockMappings

Prefer block-style mappings over flow-style mappings.

✅ This rule is included in the yaml stylistic presets.

Flow-style mappings (e.g., {key: value}) can be harder to read and maintain, especially with nested structures. Block-style mappings use indentation to show structure, making the YAML more readable and consistent with common YAML conventions.

Examples

❌ Incorrect

key: { nested: value }

outer: { inner: value, another: data }

✅ Correct

key:
  nested: value

outer:
  inner: value
  another: data

Options

This rule is not configurable.

When Not To Use It

If you’re working with a large existing YAML codebase that predominantly uses flow-style mappings and refactoring would be too disruptive, you might choose to disable this rule. However, block-style mappings are generally more readable and maintainable, especially as configurations grow in complexity.

Further Reading

• YAML Specification: Flow Mappings
• YAML Specification: Block Mappings

Equivalents in Other Linters

• ESLint: yml/block-mapping