feat: initial commit

docs/development/linters.md

@@ -0,0 +1,86 @@
+# Linter configs
+
+## ansible-lint
+
+```shell
+---
+
+exclude_paths:
+  - ".gitlab/*"
+  - ".gitlab-ci.yml"
+  - "defaults/main.yaml"
+  - "meta/main.yaml"
+  - "vars/*"
+
+kinds:
+  - playbook: "**/*.{yml,yaml}"
+
+skip_list:
+  - "command-shell"
+  - "experimental"
+  - "git-latest"
+  - "no-changed-when"
+  - "no-handler"
+  - "name[casing]"
+  - "name[template]"
+  - "risky-file-permissions"
+  - "schema[playbook]"
+  - "var-naming[no-role-prefix]"
+```
+
+## markdownlint
+
+```shell
+---
+
+default: true
+
+# MD013/line-length - line length
+MD013:
+  line_length: 120
+  tables: false
+
+# MD025/single-title/single-h1 - multiple top-level headings
+# (allow multiple top-level headings)
+MD025: false
+
+# MD033/no-inline-html - inline html
+MD033:
+  allowed_elements: ["br"]
+```
+
+## yamllint
+
+```shell
+---
+
+extends: "default"
+
+rules:
+  braces:
+    max-spaces-inside: 1
+    forbid: true
+  comments:
+    min-spaces-from-content: 1
+  comments-indentation: false
+  empty-lines:
+    max: 2
+  indentation:
+    spaces: 2
+    check-multi-line-strings: true
+  line-length:
+    max: 120
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: true
+  new-line-at-end-of-file: "enable"
+  octal-values:
+    forbid-implicit-octal: true
+    forbid-explicit-octal: true
+  truthy:
+    allowed-values:
+      - "false"
+      - "true"
+  quoted-strings:
+    quote-type: "any"
+    required: true
+```