StructuralExplainability/.pre-commit-config.yaml at main · structural-explainability/StructuralExplainability · 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
# ============================================================
# .pre-commit-config.yaml (Lean Hygiene)
# ============================================================
# VARIANT: lean-hygiene
# SOURCE: https://github.com/denisecase/templates
#
# REQ: Lean repos MAY include a .pre-commit-config.yaml for repo hygiene (optional).
# WHY: Keep diffs clean across OSes and validate repo metadata files (TOML/YAML/JSON).
#
# OBS: These hooks use and do NOT override:
#   - .editorconfig (whitespace / indentation)
#   - .gitattributes (EOL normalization)
#   - tool configs (if present), e.g., lakefile.lean, pyproject.toml
#
# OPTIONAL LOCAL USAGE (no repo venv required):
#   Install uv (once, user-level).
#   uv self update
#   uvx pre-commit install
#   uvx pre-commit run --all-files (just once, to check all files)
# Subsequent commits will AUTOMATICALLY run pre-commit hooks after git add
# and before git commit.
#
# NOTE: pre-commit is optional.
#   Repositories do NOT require Python, uv, or pre-commit to clone or commit.

exclude: |
  (?x)^(
    \.DS_Store|
    \.coverage|
    \.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/
  )

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

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

      - id: check-yaml
        name: B3) Validate YAML syntax
        files: \.(yml|yaml)$
        exclude: ^mkdocs\.ya?ml$ # OBS: mkdocs.yaml may include non-standard tags.

      # === 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

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