.yamllint

# -*- coding: utf-8 -*-
# vim: ft=yaml
---
# Extend the `default` configuration provided by `yamllint`
extends: 'default'

# Files to ignore completely
# 1. All YAML files under directory `.bundle/`, introduced if gems are installed locally
# 2. All YAML files under directory `.cache/`, introduced during the CI run
# 3. All YAML files under directory `.git/`
# 4. All YAML files under directory `node_modules/`, introduced during the CI run
# 5. Any SLS files under directory `test/`, which are actually state files
# 6. Any YAML files under directory `.kitchen/`, introduced during local testing
# 7. `kitchen.vagrant.yml`, which contains Embedded Ruby (ERB) template syntax
# 8. All Jinja templates under `ssf/files/` (result in `yamllint` syntax errors)
#    Not disabling via. `*.yml` since we may end up with non-Jinja YAML files here
ignore: |
  .bundle/
  .cache/
  .git/
  node_modules/
  test/**/states/**/*.sls
  .kitchen/
  kitchen.vagrant.yml
  ssf/files/default/.cirrus.yml
  ssf/files/default/.gitlab-ci.yml
  ssf/files/default/.pre-commit-config.yaml
  ssf/files/default/.rubocop.yml
  ssf/files/default/.salt-lint
  ssf/files/default/.travis.yml
  ssf/files/default/.yamllint
  ssf/files/default/inspec/inspec.yml
  ssf/files/default/kitchen.yml
  ssf/files/default/kitchen.macos.yml
  ssf/files/default/kitchen.windows.yml
  ssf/files/default/.github/workflows/kitchen.yml
  ssf/files/default/.github/workflows/kitchen.macos.yml
  ssf/files/default/.github/workflows/kitchen.windows.yml
  ssf/files/tofs_ssf-formula/.yamllint

yaml-files:
  # Default settings
  - '*.yaml'
  - '*.yml'
  - .salt-lint
  - .yamllint
  # SaltStack Formulas additional settings
  - '*.example'
  - test/**/*.sls

rules:
  commas:
    # Allow separation between commas to achieve tabular layout under `platforms`
    ignore: |
      ssf/defaults.yaml
      ssf/formulas.yaml
  empty-values:
    forbid-in-block-mappings: true
    forbid-in-flow-mappings: true
  line-length:
    # Allow comment that requires Jinja escapes, which renders without excessive
    # line length
    ignore: |
      ssf/files/tofs_rabbitmq-formula/.salt-lint
    # Increase from default of `80`
    # Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
    max: 88
  octal-values:
    forbid-implicit-octal: true
    forbid-explicit-octal: true
  # yamllint disable rule:comments-indentation
  # Disable this rule for the time being due to numerous violations detected after
  # update to `1.22.0` (Fix quoted-strings rule not working on sequences items), see:
  # https://github.com/adrienverge/yamllint/blob/master/CHANGELOG.rst#1220-2020-04-13
  # quoted-strings:
  #   quote-type: 'single'
  # yamllint enable rule:comments-indentation