OceanPath/.pre-commit-config.yaml at main · Lyce24/OceanPath · 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
# Pre-commit hooks for OceanPath
# Install: pre-commit install
# Run all: pre-commit run --all-files
# Update:  pre-commit autoupdate

repos:
  # ── Ruff: lint + format (replaces black, isort, flake8) ──────────────
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.15.2
    hooks:
      - id: ruff
        name: ruff lint
        args: [--fix, --exit-non-zero-on-fix]
        types_or: [python, pyi, jupyter]
      - id: ruff-format
        name: ruff format
        types_or: [python, pyi, jupyter]

  # ── Standard file hygiene ────────────────────────────────────────────
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: trailing-whitespace
        args: [--markdown-linebreak-ext=md]
      - id: end-of-file-fixer
      - id: check-yaml
        args: [--allow-multiple-documents]
      - id: check-toml
      - id: check-added-large-files
        args: [--maxkb=500]
      - id: check-merge-conflict
      - id: debug-statements           # no pdb left in code
      - id: check-ast                   # valid Python syntax
      - id: mixed-line-ending

  # ── YAML lint (catches Hydra config errors) ──────────────────────────
  - repo: https://github.com/adrienverge/yamllint
    rev: v1.38.0
    hooks:
      - id: yamllint
        args: [-d, "{extends: relaxed, rules: {line-length: {max: 120}}}"]
        files: \.(yaml|yml)$
        exclude: uv\.lock

  # ── Mypy (optional — run manually or in CI) ─────────────────────────
  # Uncomment when ready for strict type checking:
  # - repo: https://github.com/pre-commit/mirrors-mypy
  #   rev: v1.19.1
  #   hooks:
  #     - id: mypy
  #       additional_dependencies: [torch, numpy, pandas-stubs]
  #       args: [--config-file=pyproject.toml]
  #       pass_filenames: false