ansible-later/docs/content/configuration/defaults.md
Robert Kaussow 53444a4a75
feat: allow to set standards version in config file (#69)
* feat: allow to set standards version in config file

* add documentation
2021-02-01 20:27:00 +01:00

2.1 KiB

title
Default settings

{{< highlight YAML "linenos=table" >}}

ansible:

Add the name of used custom Ansible modules. Otherwise ansible-later

can't detect unknown modules and will through an error.

Modules which are bundled with the role and placed in a './library'

directory will be auto-detected and don't need to be added to this list.

custom_modules: []

Settings for variable formatting rule (ANSIBLE0004)

double-braces: max-spaces-inside: 1 min-spaces-inside: 1

Global logging configuration

If you would like to force colored output (e.g. non-tty)

set environment variable PY_COLORS=1

logging:

You can enable JSON logging if a parsable output is required

json: False

Possible options debug | info | warning | error | critical

level: "warning"

Global settings for all defined rules

rules:

Disable build-in rules if required

buildin: True

List of files to exclude

exclude_files: []

Examples:

- molecule/

- files/**/*.py

Limit checks to given rule ID's

If empty all rules will be used.

filter: []

Exclude given rule ID's from checks

exclude_filter: []

All dotfiles (including hidden folders) are excluded by default.

You can disable this setting and handle dotfiles by yourself with exclude_files.

ignore_dotfiles: True

List of directories to load standard rules from (defaults to build-in)

standards: []

Standard version to use. Standard version set in a roles meta file

or playbook will takes precedence.

version:

Block to control included yamllint rules.

See https://yamllint.readthedocs.io/en/stable/rules.html

yamllint: colons: max-spaces-after: 1 max-spaces-before: 0 document-start: present: True empty-lines: max: 1 max-end: 1 max-start: 0 hyphens: max-spaces-after: 1 indentation: check-multi-line-strings: False indent-sequences: True spaces: 2 {{< /highlight >}}