ansible-later/ansiblelater/rules/CheckYamlDocumentStart.py

from ansiblelater.rule import RuleBase


class CheckYamlDocumentStart(RuleBase):
    rid = "YML104"
    description = "YAML should contain document start marker"
    types = ["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)
refactor: drop default standards version and rename to rules (#752) BREAKING CHANGE: The option to define a `Standards` version has been removed. Every new rule that is added on upcoming releases is activated by default and will also create errors if triggered. The behavior of rules can be controlled by the existing `rules.exclude_filter` or `rules.warning_filter` options. BREAKING CHANGE: The option `rules.buildin` has been renamed to `rules.builtin`. BREAKING CHANGE: The option `rules.standards` has been renamed to `rules.dir`. BREAKING CHANGE: The option `rules.filter` has been renamed to `rules.include_filter`. 2024-01-25 20:40:15 +00:00			`from ansiblelater.rule import RuleBase`
refactor plugin system to use a class-based approach (#68) * refactor plugin system to use a class-based approach * disable some docstring linter errors and fix imports * cleanup * fix docs * add metavars to cli arguments for better helptext * add option to disable buildin rules * remove print * remove dead code 2021-01-30 15:52:48 +00:00

refactor: drop default standards version and rename to rules (#752) BREAKING CHANGE: The option to define a `Standards` version has been removed. Every new rule that is added on upcoming releases is activated by default and will also create errors if triggered. The behavior of rules can be controlled by the existing `rules.exclude_filter` or `rules.warning_filter` options. BREAKING CHANGE: The option `rules.buildin` has been renamed to `rules.builtin`. BREAKING CHANGE: The option `rules.standards` has been renamed to `rules.dir`. BREAKING CHANGE: The option `rules.filter` has been renamed to `rules.include_filter`. 2024-01-25 20:40:15 +00:00			`class CheckYamlDocumentStart(RuleBase):`
refactor: use lint-like rule identifier 2024-01-27 17:32:29 +00:00			`rid = "YML104"`
refactor plugin system to use a class-based approach (#68) * refactor plugin system to use a class-based approach * disable some docstring linter errors and fix imports * cleanup * fix docs * add metavars to cli arguments for better helptext * add option to disable buildin rules * remove print * remove dead code 2021-01-30 15:52:48 +00:00			`description = "YAML should contain document start marker"`
			`types = ["playbook", "task", "handler", "rolevars", "hostvars", "groupvars", "meta"]`

			`def check(self, candidate, settings):`
refactor: replace str.format with f-strings (#521) 2023-01-09 10:59:25 +00:00			`options = f"rules: {{document-start: {settings['yamllint']['document-start']}}}"`
refactor plugin system to use a class-based approach (#68) * refactor plugin system to use a class-based approach * disable some docstring linter errors and fix imports * cleanup * fix docs * add metavars to cli arguments for better helptext * add option to disable buildin rules * remove print * remove dead code 2021-01-30 15:52:48 +00:00			`errors = self.run_yamllint(candidate, options)`

			`return self.Result(candidate.path, errors)`