.pre-commit-config.yaml

ci:
  # Don't push commits on to PRs. If you want this, it can be triggered with a
  # comment in a PR with text "pre-commit.ci autofix"
  autofix_prs: false
  autoupdate_schedule: "quarterly"

repos:
  - repo: "https://github.com/python-jsonschema/check-jsonschema"
    rev: "0.28.6"
    hooks:
      - id: "check-github-workflows"
      # TODO: Re-enable. The checker and the docs say `build.tools` is
      #       required, but we're doing a fully custom build and don't actually
      #       need it.
      #         https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools
      # - id: "check-readthedocs"

  - repo: https://github.com/psf/black-pre-commit-mirror
    rev: "24.4.2"
    hooks:
      # With notebook support:
      # - id: black-jupyter
      - id: black

  - repo: https://github.com/asottile/blacken-docs
    rev: "1.18.0"
    hooks:
      - id: blacken-docs
        additional_dependencies: [black==23.9.1]

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: "v4.6.0"
    hooks:
      - id: check-added-large-files
      - id: check-case-conflict
      - id: check-merge-conflict
      - id: check-symlinks
      - id: check-yaml
        # Without --unsafe, !reset in compose YAML triggers error
        args: ["--unsafe"]
      - id: debug-statements
      # - id: end-of-file-fixer
      # - id: mixed-line-ending
      - id: name-tests-test
        args: ["--pytest-test-first"]
      # - id: trailing-whitespace

  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: "v1.10.0"
    hooks:
      - id: rst-backticks
      - id: rst-directive-colons
      - id: rst-inline-touching-normal

  - repo: "https://github.com/rbubley/mirrors-prettier"
    rev: "v3.3.2"
    hooks:
      - id: prettier
        types_or: [json]
        exclude: ".geojson$"
        # types_or: [yaml, markdown, html, css, scss, javascript, json]
        args: [--prose-wrap=always]

  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: "v0.5.0"
    hooks:
      - id: ruff
        args: ["--fix", "--show-fixes", "--exit-non-zero-on-fix"]

  # Does it make sense to run MyPy with pre-commit? I thought I'd seen the
  # authors advise against.
  # - repo: https://github.com/pre-commit/mirrors-mypy
  #   rev: "v1.5.1"
  #   hooks:
  #     - id: mypy
  #       files: src|tests
  #       args: []
  #       additional_dependencies:
  #         - pytest

  # TODO: Configure in pyproject.toml
  - repo: https://github.com/codespell-project/codespell
    rev: "v2.3.0"
    hooks:
      - id: codespell
        exclude: >
          (?x)^(
            ^.*/example_data/.*
            |^.*\\.bin
            |^.*\\.ipynb
            |^.*json
          )$

  # TODO: ENABLE SHELLCHECK!
  # - repo: https://github.com/shellcheck-py/shellcheck-py
  #   rev: "v0.9.0.5"
  #   hooks:
  #     - id: shellcheck