.pre-commit-config.yaml

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0
    hooks:
    -   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-byte-order-marker # forbids files which have a utf-8 byte-order marker.
    -   id: check-case-conflict # checks for files that would conflict in case-insensitive filesystems.
    -   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.
    -   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.
    -   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-private-key # detects the presence of private keys.
    -   id: end-of-file-fixer # ensures that a file is either empty, or ends with one newline.
    -   id: fix-byte-order-marker # removes utf-8 byte order marker.
    -   id: mixed-line-ending # replaces or checks mixed line ending.
    -   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.