ansible-later/ansiblelater/rules/CheckYamlDocumentStart.py

from typing import ClassVar

from ansiblelater.standard import StandardBase


class CheckYamlDocumentStart(StandardBase):

    sid = "LINT0004"
    description = "YAML should contain document start marker"
    version = "0.1"
    types: ClassVar[list[str]] = [
        "playbook", "task", "handler", "rolevars", "hostvars", "groupvars", "meta"
    ]

    def check(self, candidate, settings):
        options = f"rules: {{document-start: {settings['yamllint']['document-start']}}}"
        errors = self.run_yamllint(candidate, options)

        return self.Result(candidate.path, errors)