.pre-commit-config.yaml

ci:
  autoupdate_schedule: "quarterly"

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v5.0.0
  hooks:
    - id: check-merge-conflict
    - id: trailing-whitespace
- repo: https://github.com/python-jsonschema/check-jsonschema
  rev: 0.29.3
  hooks:
    - id: check-github-workflows
    - id: check-readthedocs
- repo: https://github.com/asottile/pyupgrade
  rev: v3.17.0
  hooks:
    - id: pyupgrade
      args: ["--py37-plus"]
- repo: https://github.com/psf/black-pre-commit-mirror
  rev: 24.10.0
  hooks:
    - id: black
      name: "Autoformat python files"
- repo: https://github.com/adamchainz/blacken-docs
  rev: 1.18.0
  hooks:
    - id: blacken-docs
      additional_dependencies: ['black==23.9.1']
- repo: https://github.com/PyCQA/flake8
  rev: 7.1.1
  hooks:
    - id: flake8
      name: "Lint python files"
      additional_dependencies:
        - 'flake8-bugbear==24.8.19'
        - 'flake8-comprehensions==3.15.0'
        - 'flake8-typing-as-t==0.0.3'
- repo: https://github.com/PyCQA/isort
  rev: 5.13.2
  hooks:
    - id: isort
      name: "Sort python imports"
- repo: https://github.com/sirosen/slyp
  rev: 0.7.1
  hooks:
    - id: slyp
- repo: https://github.com/codespell-project/codespell
  rev: v2.3.0
  hooks:
    - id: codespell
      args: ["--ignore-regex", "https://[^\\s]*"]
- repo: https://github.com/sirosen/texthooks
  rev: 0.6.7
  hooks:
    - id: alphabetize-codeowners
- repo: https://github.com/rhysd/actionlint
  rev: v1.7.4
  hooks:
    - id: actionlint

# custom local hooks
- repo: local
  hooks:
    - id: forbid-code-block-without-language
      name: Require code-block directives to specify a language
      types_or: [python,rst]
      language: pygrep
      entry: "\\.\\. +code-block::$"
    - id: ensure-all-exports-documented
      name: "Check that all public symbols are documented"
      entry: ./scripts/ensure_exports_are_documented.py
      language: python
      always_run: true
      pass_filenames: false