.pre-commit-config.yaml

---
repos:
  # Quick content checks based on grepping for python specific patterns:
  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.10.0
    hooks:
      - id: rst-backticks # Find single rather than double backticks
      - id: rst-directive-colons # Missing double-colons after directives
      - id: rst-inline-touching-normal # Inline code should never touch normal text
      - id: python-use-type-annotations # Use annotations not old-style type comments

  # Other file formatting, plus common Git mistakes & text file standardization:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: check-added-large-files # Don't accidentally commit giant files.
      - id: check-merge-conflict # Watch for lingering merge markers.
      - id: check-yaml # Validate all YAML files.
      - id: check-toml
      - id: check-case-conflict # Avoid case sensitivity in file names.
      - id: debug-statements # Watch for lingering debugger calls.
      - id: mixed-line-ending # Use Unix line-endings to avoid big no-op CSV diffs.
        args: ["--fix=lf"]
      - id: trailing-whitespace
      - id: name-tests-test # Follow PyTest naming convention.
      - id: end-of-file-fixer

  ####################################################################################
  # Formatters: hooks that re-write Python & documentation files
  ####################################################################################
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.5.7
    hooks:
      - id: ruff
        args: [--fix, --exit-non-zero-on-fix]
      - id: ruff-format

  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v3.1.0
    hooks:
      - id: prettier
        types_or: [yaml]

  ####################################################################################
  # Linters: hooks that check but don't alter files
  ####################################################################################

  # Lint Dockerfiles for errors and to ensure best practices
  - repo: https://github.com/AleksaC/hadolint-py
    rev: v2.12.0.3
    hooks:
      - id: hadolint

  # Check for errors in restructuredtext (.rst) files under the doc hierarchy
  - repo: https://github.com/PyCQA/doc8
    rev: v1.1.1
    hooks:
      - id: doc8
        args: [--config, pyproject.toml]

  #####################################################################################
  # Our own pre-commit hooks, which don't come from the pre-commit project
  #####################################################################################
  - repo: local
    hooks:
      - id: nb-output-clear
        name: nb-output-clear
        stages: [commit]
        language: system
        verbose: false
        files: ".*\\.ipynb"
        pass_filenames: true
        always_run: false
        entry: jupyter nbconvert --clear-output

      - id: unit-tests
        name: unit-tests
        stages: [commit]
        language: system
        verbose: false
        pass_filenames: false
        always_run: true
        entry: pytest --cov-fail-under=0 --doctest-modules src/pudl test/unit -m "not slow"

      - id: conda-lock
        name: conda-lock
        stages: [commit]
        language: system
        verbose: false
        files: "pyproject.toml"
        always_run: false
        entry: make conda-clean conda-lock.yml

# Configuration for pre-commit.ci
ci:
  autofix_commit_msg: |
    [pre-commit.ci] auto fixes from pre-commit.com hooks

    For more information, see https://pre-commit.ci
  autofix_prs: true
  autoupdate_branch: main
  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
  autoupdate_schedule: weekly
  skip: [unit-tests, nb-output-clear, conda-lock]
  submodules: false