.pre-commit-config.yaml

repos:
  ### LOCAL

  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: 0d9fcb51a54f3b750b911c054b4bd1a590f1b592 # frozen: v0.43.0
    hooks:
      - id: markdownlint-fix

  ### PYTHON

  - repo: https://github.com/psf/black
    rev: 1b2427a2b785cc4aac97c19bb4b9a0de063f9547 # frozen: 24.10.0
    hooks: # https://black.readthedocs.io/en/stable/integrations/source_version_control.html
      - id: black

  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: 8b76f04e7e5a9cd259e9d1db7799599355f97cdf # frozen: v0.8.2
    hooks: # https://beta.ruff.rs/docs/installation-and-usage/#usage
      - id: ruff
        args: [--fix]
      - id: ruff-format

  - repo: https://github.com/asottile/pyupgrade
    rev: 19364aa1b2ac289ce75e6bbe93994f7b4b9425f6 # frozen: v3.19.0
    hooks:
      - id: pyupgrade

  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: 3a6eb0fadf60b3cccfd80bad9dbb6fae7e47b316 # frozen: v1.10.0
    hooks:
      - id: python-check-blanket-noqa
      - id: python-no-eval
      - id: python-no-log-warn
      - id: python-use-type-annotations
      - id: text-unicode-replacement-char

  - repo: https://github.com/tox-dev/pyproject-fmt
    rev: "6b2f3b33754de7a442043dc312fc5a0e473086d2" # frozen: v2.5.0
    hooks:
      - id: pyproject-fmt

  ### MISC

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # frozen: v5.0.0
    hooks: # https://pre-commit.com/hooks.html
      # `(\S) - ` -> `$1 # `
      - id: check-added-large-files # prevents giant files from being committed.
      - id: check-ast # simply checks whether the files parse as valid python.
      - id: check-builtin-literals # requires literal syntax when initializing empty or zero python builtin types.
      - id: check-case-conflict # checks for files that would conflict in case-insensitive filesystems.
      # - id: check-docstring-first # checks a common error of defining a docstring after code.
      - id: check-executables-have-shebangs # ensures that (non-binary) executables have a shebang.
      - id: check-json # checks json files for parseable syntax.
      - id: check-shebang-scripts-are-executable # ensures that (non-binary) files with a shebang are executable.
      - id: pretty-format-json # sets a standard for formatting json files.
        args:
          - --autofix
          - --indent=2
          - --no-sort-keys
          - --no-ensure-ascii
      - id: check-merge-conflict # checks for files that contain merge conflict strings.
      # - id: check-symlinks # checks for symlinks which do not point to anything.
      - id: check-toml # checks toml files for parseable syntax.
      - id: check-vcs-permalinks # ensures that links to vcs websites are permalinks.
      # - id: check-xml # checks xml files for parseable syntax.
      - id: check-yaml # checks yaml files for parseable syntax.
        args:
          - --allow-multiple-documents
        exclude: mkdocs.yml
      - id: debug-statements # checks for debugger imports and py37+ `breakpoint()` calls in python source.
      # - id: destroyed-symlinks # detects symlinks which are changed to regular files with a content of a path which that symlink was pointing to.
      # - id: detect-aws-credentials # detects *your* aws credentials from the aws cli credentials file.
      - id: detect-private-key # detects the presence of private keys.
      # - id: double-quote-string-fixer # replaces double quoted strings with single quoted strings.
      - id: end-of-file-fixer # ensures that a file is either empty, or ends with one newline.
        exclude: package.json
      # - id: file-contents-sorter # sorts the lines in specified files (defaults to alphabetical). you must provide list of target files as input in your .pre-commit-config.yaml file.
      - id: fix-byte-order-marker # removes utf-8 byte order marker.
      # - id: fix-encoding-pragma # adds # -*- coding: utf-8 -*- to the top of python files.
      # - id: forbid-new-submodules # prevents addition of new git submodules.
      # - id: forbid-submodules # forbids any submodules in the repository
      - id: mixed-line-ending # replaces or checks mixed line ending.
      - id: name-tests-test # verifies that test files are named correctly.
        args:
          - --pytest-test-first
      # - id: no-commit-to-branch # don't commit to branch
      # - id: requirements-txt-fixer # sorts entries in requirements.txt.
      # - id: sort-simple-yaml # sorts simple yaml files which consist only of top-level keys, preserving comments and blocks.
      - id: trailing-whitespace # trims trailing whitespace.