ansible-later/ansiblelater/rules/CheckYamlHasContent.py

from ansiblelater.rule import RuleBase


class CheckYamlHasContent(RuleBase):
    rid = "YML107"
    description = "Files should contain useful content"
    helptext = "the file appears to have no useful content"
    types = ["playbook", "task", "handler", "rolevars", "defaults", "meta"]

    def check(self, candidate, settings):
        yamllines, errors = self.get_normalized_yaml(candidate, settings)

        if (not candidate.faulty and len(yamllines) == 0) and not errors:
            errors.append(self.Error(None, self.helptext))

        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 CheckYamlHasContent(RuleBase):`
refactor: use lint-like rule identifier (#757) 2024-01-27 18:56:35 +00:00			`rid = "YML107"`
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 = "Files should contain useful content"`
			`helptext = "the file appears to have no useful content"`
			`types = ["playbook", "task", "handler", "rolevars", "defaults", "meta"]`

			`def check(self, candidate, settings):`
			`yamllines, errors = self.get_normalized_yaml(candidate, settings)`

			`if (not candidate.faulty and len(yamllines) == 0) and not errors:`
			`errors.append(self.Error(None, self.helptext))`

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