website/.overcommit.yml at master · Constructive-Programming/website · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# Linting for the site, Ruby/bundler based (replaces the previous
# pre-commit/python setup with the same checks):
#
#   Local hooks:  bundle exec overcommit --install
#   Whole repo:   scripts/lint.sh   (= `bundle exec overcommit --run`)
#   CI:           .github/workflows/lint.yml runs scripts/lint.sh
#
# Local hooks and CI execute this same configuration, so they cannot drift.
#
# Signature verification is off so CI can run `overcommit --run` on a fresh
# checkout (signatures live in the local git config, which CI never has).
verify_signatures: false

# Make the installed git hooks resolve gems through the bundle, so hooks find
# `mdl` and friends without a system-wide gem install.
gemfile: Gemfile

# Only print hook output when a hook warns or fails.
quiet: true

PreCommit:
  AuthorName:
    enabled: false

  AuthorEmail:
    enabled: false

  # Hygiene checks (previously pre-commit-hooks):
  #   trailing whitespace -> TrailingWhitespace, CRLF check dropped (repo is
  #   LF only), case conflicts -> CaseConflicts, merge markers ->
  #   MergeConflicts, YAML/JSON syntax -> YamlSyntax/JsonSyntax, final
  #   newline -> FinalNewline, shebang/exec-bit consistency ->
  #   CheckExecutableShebangs.

  CaseConflicts:
    enabled: true

  MergeConflicts:
    enabled: true

  TrailingWhitespace:
    enabled: true
    requires_files: true

  JsonSyntax:
    enabled: true
    requires_files: true
    exclude:
      # search.json is a Jekyll/Liquid template with front matter,
      # not a plain JSON file.
      - 'assets/data/search.json'

  YamlSyntax:
    enabled: true
    requires_files: true

  FinalNewline:
    enabled: true
    requires_files: true

  CheckExecutableShebangs:
    enabled: true
    requires_files: true

  # Markdown style (previously markdownlint-cli2). Rules live in .mdlrc +
  # mdl_style.rb, shared with any editor or manual `mdl` run.
  Mdl:
    enabled: true
    requires_files: true
    command: ['bundle', 'exec', 'mdl']
    exclude:
      # The refactorings section carries raw-HTML citation blocks (single
      # <li> lines with entities/URLs) and ref-link prose that the
      # refactoring skill writes deliberately; those can't be wrapped to
      # 80 cols without breaking the markup. Exempt only that section.
      - 'pages/refactorings/**/*'
      # .claude/skills are agent-internal docs, not site prose.
      - '.claude/**/*'
      # The catalogue index page has the same citation conventions.
      - 'pages/refactorings.md'

  # Spelling with spellr (Ruby, replaces codespell — see
  # .git-hooks/pre_commit/spellr.rb). Wordlist: .spellr_wordlists/.
  Spellr:
    enabled: true
    requires_files: true

  # Refactoring sample sources must stay within the 72-char pane width
  # (previously scripts/check-sample-width.sh via pre-commit).
  RefactoringSampleWidth:
    enabled: true
    requires_files: true
    include:
      - 'pages/refactorings/**/*.{scala,hs}'