document-start.md

Pattern: Malformed use of ---

Issue: -

Description

This rule requires or forbids the use of document start marker (---).

Configuration

• Set present to true when the document start marker is required, or to false when it is forbidden.

Examples

1. With document-start: {present: true}

   the following code snippet would PASS:

   ---
   this:
     is: [a, document]
   ---
   - this
   - is: another one
   

   the following code snippet would FAIL:

   this:
     is: [a, document]
   ---
   - this
   - is: another one
   

2. With document-start: {present: false}

   the following code snippet would PASS:

   this:
     is: [a, document]
   ...
   

   the following code snippet would FAIL:

   ---
   this:
     is: [a, document]
   ...
   

Further Reading

• Yamllint - document_start