regelrecht/.yamllint at main · MinBZK/regelrecht · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
---
# yamllint configuration for machine-readable legal documents
# https://yamllint.readthedocs.io/

extends: default

rules:
  # Document structure
  document-start:
    present: true
    level: error

  document-end: disable

  # Line length - enforce wrapping for readability
  line-length:
    max: 125  # Slightly higher to account for word boundaries
    level: error
    allow-non-breakable-inline-mappings: true

  # Indentation - enforce 2-space with indented sequences
  indentation:
    spaces: 2
    indent-sequences: true  # Enforce indented sequences
    check-multi-line-strings: false  # Legal text can be long

  # Quotes - only when needed
  quoted-strings:
    quote-type: single
    required: only-when-needed
    check-keys: false

  # Booleans - explicit true/false only
  truthy:
    allowed-values: ['true', 'false']
    check-keys: false

  # Comments
  comments:
    min-spaces-from-content: 2
    require-starting-space: true
    ignore-shebangs: true

  comments-indentation: enable

  # Empty lines
  empty-lines:
    max: 2
    max-start: 0
    max-end: 0

  # Hyphens (list items)
  hyphens:
    max-spaces-after: 1

  # Keep defaults for these important rules
  key-duplicates: enable
  trailing-spaces: enable
  new-line-at-end-of-file: enable
  empty-values: disable  # Allow for schema placeholders
  brackets: enable
  braces: enable
  colons: enable
  commas: enable
  anchors: enable

  # Not relevant for this project
  key-ordering: disable
  octal-values: disable

# Ignore patterns
ignore: |
  frontend/
  .venv/
  .tox/
  node_modules/
  .github/workflows/