.pre-commit-config.yaml

# Configuration-file for pre-commit
# References:
#   - Official docs: https://pre-commit.com
#   - for more hooks: https://pre-commit.com/hooks.html
#
# To avoid duplication, we try to configure the tools in pyproject.toml as much as possible.
# we call the executables via "poetry run <executable>"
#
# Usage:
#   > pre-commit install
#   > pre-commit install hooks  -f
#   > pre-commit autoupdate
#   > pre-commit run --all-files

# default_install_hook_types: [commit-msg, pre-commit]

# configuration-wide default for the stages property of hooks.
# This will only override individual hooks that do not set stages.
# default_stages: [commit, manual, pre-commit, pre-push]  # default: (all stages)

default_language_version:
  python: python3.11

# to have pre-commit stop running hooks after the first failure
fail_fast: false # default: false

repos:
  - repo: local
    hooks:
      # docs: https://black.readthedocs.io/en/stable/integrations/source_version_control.html
      - id: black
        name: Black
        entry: poetry run black
        args: ["--config=pyproject.toml"]
        # "--check",  # don't write the files back, just return the status.
        language: system # use executable found on path
        require_serial: true
        types: [python] # check only specific filetypes

  # docs: https://flake8.pycqa.org/en/latest/user/using-hooks.html
  - repo: local
    hooks:
      - id: flake8
        name: Flake8
        entry: poetry run flake8
        language: system
        require_serial: true
        types: [python]

  # docs: https://pycqa.github.io/isort/docs/configuration/pre-commit.html
  - repo: local
    hooks:
      - id: isort
        name: Isort
        entry: poetry run isort
        args: ["--settings-path=pyproject.toml"] # "--filter-files"
        language: system
        require_serial: true
        types: [python] # pyi? cython?

  - repo: local
    hooks:
      - id: ruff
        name: Ruff
        entry: poetry run ruff
        args: [--fix, --show-fixes]
        language: system
        types: [python]

  - repo: local
    hooks:
      - id: mypy
        name: Mypy
        entry: poetry run mypy
        language: system
        types: [python]

  - repo: local
    hooks:
      - id: bandit
        name: Bandit
        entry: poetry run bandit
        language: system
        types: [python]
        # see https://github.com/PyCQA/bandit/issues/318
        args: ["--configfile pyproject.toml", "--baseline etc/bandit-baseline.json"]

  # The following are all pre-commit-hooks
  # docs: https://github.com/pre-commit/pre-commit-hooks

  - repo: local
    hooks:
      - id: check-case-conflict
        name: Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.
        entry: poetry run check-case-conflict
        language: system
        types: [text]

  - repo: local
    hooks:
      - id: debug-statements
        name: Check debug statements
        entry: poetry run debug-statement-hook
        language: system
        types: [python]

  - repo: local
    hooks:
      - id: check-toml
        name: Check TOML-syntax
        entry: poetry run check-toml
        language: system
        types: [toml]

  - repo: local
    hooks:
      - id: check-xml
        name: Check XML-syntax
        entry: poetry run check-xml
        language: system
        types: [xml]

  - repo: local
    hooks:
      - id: check-yaml
        name: Check YAML-syntax
        entry: poetry run check-yaml
        language: system
        types: [yaml]
        # exclude: "etc/logging.yaml"

  - repo: local
    hooks:
      - id: check-merge-conflict
        name: Check for files that contain merge conflict strings
        entry: poetry run check-merge-conflict
        language: system
        types: [text]
        args: ["--assume-in-mergel"] # Allow running this hook when there is no ongoing merge operation

  - repo: local
    hooks:
      - id: end-of-file-fixer
        name: Fix End of Files
        entry: poetry run end-of-file-fixer
        language: system
        stages: [commit, push, manual]
        types: [python] # text too broad?

  - repo: local
    hooks:
      - id: fix-encoding-pragma
        name: Fix encoding pragma
        entry: poetry run fix-encoding-pragma
        language: system
        types: [python]

  - repo: local
    hooks:
      - id: mixed-line-ending
        name: Fix mixed line-endings
        entry: poetry run mixed-line-ending
        language: system
        types: [text]

  - repo: local
    hooks:
      - id: trailing-whitespace
        name: Trim Trailing Whitespace # fix-trailing-whitespace
        entry: poetry run trailing-whitespace-fixer
        language: system
        stages: [commit, push, manual]
        types: [text]