.github/.pre-commit-config.yaml at main · structural-explainability/.github · 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# ============================================================
# .pre-commit-config.yaml (Markdown Hygiene)
# ============================================================
# Updated: 2026-06-04
# WHY: Fast, consistent repo hygiene before commit.
#
# These hooks complement and do not replace:
# - .editorconfig
# - .gitattributes
# - pyproject.toml
#
# Local usage:
#   uv self update
#   uvx pre-commit install
#   uvx pre-commit run --all-files
#
# Ruff lint runs before Ruff format in pre-commit so autofixes
# are formatted in the same pass.

exclude: |
  (?x)^(
    \.coverage|
    \.DS_Store|
    \.ipynb_checkpoints/|
    \.mypy_cache/|
    \.nox/|
    \.pytest_cache/|
    \.ruff_cache/|
    \.tox/|
    \.venv/|
    .*\.(egg-info)/|
    .*\.log|
    __pycache__/|
    _minted.*/|
    build/|
    coverage\.xml|
    dist/|
    htmlcov/|
    lake-packages/|
    node_modules/|
    out/|
    site/|
    LICENSE|
    CODEOWNERS
  )

repos:
  # === REPO: PRE-COMMIT HOOKS (cross-platform, zero config) ===
  #
  # These hooks prevent problems that show up later as:
  #   - mysterious diffs
  #   - broken builds on another OS

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      # === PRE-COMMIT: NORMALIZE FILE FORMATTING ===

      - id: trailing-whitespace
        name: A1) Clean trailing whitespace (per .editorconfig)
        args: [--markdown-linebreak-ext=md] # Preserves markdown double-space line breaks

      - id: end-of-file-fixer
        name: A2) End files with a newline (per .gitattributes)

      - id: mixed-line-ending
        name: A3) Normalize line endings to LF before linters
        args: [--fix=lf] # OBS: Windows working copies may be CRLF.

      #  === PRE-COMMIT: CHECK DATA FILE FORMATS ===

      - id: check-json
        name: B1) Validate JSON syntax (except .vscode/)
        # WHY: VSCode settings may include comments, which are non-standard JSON.
        exclude: ^\.vscode/.*\.json$

      - id: check-toml
        name: B2) Validate TOML syntax

      - id: check-yaml
        name: B3) Validate YAML syntax
        files: \.(yml|yaml)$
        # WHY: VS Code config files are editor-specific
        exclude: ^(\.vscode/)

      # === PRE-COMMIT:CHECK FOR COMMON PROBLEMS ===

      - id: check-added-large-files
        name: C1) Prevent accidental commits of large binaries
        args: [--maxkb=500]

      - id: check-merge-conflict
        name: C2) Prevent committing merge conflicts

      - id: check-case-conflict
        name: C3) Check for filename case conflicts

  # === EXECUTE: UNIVERSAL SE REPOSITORY CHECKS ===

  - repo: local
    hooks:

      - id: markdownlint
        name: E1) Markdown lint
        language: system
        entry: npx markdownlint-cli2 --fix
        pass_filenames: false
        always_run: true

      - id: se-validate-manifest
        name: E2) Validate SE manifest against schema
        language: system
        entry: uvx se-manifest-schema validate-manifest --path SE_MANIFEST.toml --strict
        pass_filenames: false
        always_run: true

# === GLOBAL SETTINGS ===
# ALT: Set fail_fast to true to stop at first failure.
fail_fast: false # Run all hooks even if one fails