.pre-commit-config.yaml

---

ci:
  autoupdate_schedule: quarterly
  skip:
  - nitpick-check  # can't run on pre-commit.ci while using gh://

repos:
- repo: local
  hooks:
  - id: immutable-setup-py
    name: Verify that setup.py stays immutable
    description: >-
      This is a sanity check that makes sure that
      the `setup.py` file isn't changed.
    # Using Python here because using
    # shell test does not seem to work in CIs:
    entry: >-
      sh -c 'git hash-object setup.py
      |
      python -c raise\
      SystemExit\(input\(\)\ !=\ \"38cc2638672e1f6ca56e4d5ceaf16451dd702b67\"\)
      '
    pass_filenames: false
    language: system
    files: >-
      ^setup\.py$
  - id: immutable-tests-init-py
    name: Verify that tests/__init__.py stays immutable
    description: >-
      This is a sanity check that makes sure that
      the `tests/__init__.py` file isn't changed.
    # Using Python here because using
    # shell test does not seem to work in CIs:
    entry: >-
      sh -c 'git hash-object tests/__init__.py
      |
      python -c raise\
      SystemExit\(input\(\)\ !=\ \"674d7b907efe86dafcd2b8ddc5655fc55ddf5395\"\)
      '
    pass_filenames: false
    language: system
    files: >-
      ^tests/__init__\.py$

- repo: https://github.com/asottile/add-trailing-comma.git
  rev: v3.1.0
  hooks:
  - id: add-trailing-comma

- repo: https://github.com/asottile/pyupgrade.git
  rev: v3.19.1
  hooks:
  - id: pyupgrade
    args:
    - --py38-plus

- repo: https://github.com/PyCQA/isort.git
  rev: 5.13.2
  hooks:
  - id: isort
    args:
    - --honor-noqa

- repo: https://github.com/Lucas-C/pre-commit-hooks.git
  rev: v1.5.5
  hooks:
  - id: remove-tabs

- repo: https://github.com/python-jsonschema/check-jsonschema.git
  rev: 0.28.6
  hooks:
  - id: check-github-workflows
    files: ^\.github/workflows/[^/]+$
    types:
    - yaml
  - id: check-jsonschema
    name: Check GitHub Workflows set timeout-minutes
    args:
    - --builtin-schema
    - github-workflows-require-timeout
    files: ^\.github/workflows/[^/]+$
    types:
    - yaml
  # yamllint disable rule:comments-indentation
  # - id: check-readthedocs
  # yamllint enable rule:comments-indentation

- repo: https://github.com/andreoliwa/nitpick.git
  rev: v0.35.0
  hooks:
  - id: nitpick-check
    args:
    - -v
    pass_filenames: false
    stages: []

- repo: https://github.com/pre-commit/pygrep-hooks.git
  rev: v1.10.0
  hooks:
  - id: python-check-blanket-noqa
  - id: python-check-mock-methods
  - id: python-no-eval
  - id: python-no-log-warn
  - id: rst-backticks

- repo: https://github.com/pre-commit/pre-commit-hooks.git
  rev: v4.6.0
  hooks:
  # Side-effects:
  - id: trailing-whitespace
  - id: check-merge-conflict
  - id: double-quote-string-fixer
  - id: end-of-file-fixer
  - id: requirements-txt-fixer
    exclude: >-
      ^(docs/requirements|requirements-build)\.txt$
  # Non-modifying checks:
  - id: name-tests-test
    files: >-
      ^tests/[^_].*\.py$
  - id: check-added-large-files
  - id: check-byte-order-marker
  - id: check-case-conflict
  # disabled due to pre-commit/pre-commit-hooks#159
  # - id: check-docstring-first
  - id: check-json
  - id: check-symlinks
  - id: check-yaml
  #  args:
  #  - --unsafe
  - id: detect-private-key

  # Heavy checks:
  - id: check-ast
  - id: debug-statements

- repo: https://github.com/Lucas-C/pre-commit-hooks-markup.git
  rev: v1.0.1
  hooks:
  - id: rst-linter
    files: >-
      ^README\.rst$

- repo: https://github.com/PyCQA/pydocstyle.git
  rev: 6.3.0
  hooks:
  - id: pydocstyle

- repo: https://github.com/codespell-project/codespell.git
  rev: v2.3.0
  hooks:
  - id: codespell
    exclude: >-
      ^\.github/\.json-schemas/.*\.json$

- repo: https://github.com/adrienverge/yamllint.git
  rev: v1.35.1
  hooks:
  - id: yamllint
    files: \.(yaml|yml)$
    types: [file, yaml]
    args:
    - --strict

- repo: https://github.com/openstack/bashate.git
  rev: 2.1.1
  hooks:
  - id: bashate
    args:
    - -i
    - E006

- repo: https://github.com/shellcheck-py/shellcheck-py.git
  rev: v0.10.0.1
  hooks:
  - id: shellcheck

- repo: https://github.com/PyCQA/flake8.git
  rev: 7.1.0
  hooks:
  - id: flake8
    additional_dependencies:
    - flake8-2020 ~= 1.7.0
    - flake8-length ~= 0.3.0
    - flake8-pytest-style ~= 1.6.0
    - wemake-python-styleguide ~= 0.19.2
    language_version: python3

- repo: https://github.com/pre-commit/mirrors-mypy.git
  rev: v1.11.2
  hooks:
  - id: mypy
    alias: mypy-py313
    name: MyPy, for Python 3.13
    additional_dependencies:
    - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
    - pytest
    - Sphinx >= 3.1.2
    - types-colorama
    - types-Pillow
    - types-Pygments
    - types-pytz
    - types-setuptools
    args:
    - --python-version=3.13
    - --txt-report=.tox/.tmp/.test-results/mypy--py-3.13
    - --cobertura-xml-report=.tox/.tmp/.test-results/mypy--py-3.13
    - --html-report=.tox/.tmp/.test-results/mypy--py-3.13
    pass_filenames: false
  - id: mypy
    alias: mypy-py311
    name: MyPy, for Python 3.11
    additional_dependencies:
    - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
    - pytest
    - Sphinx >= 3.1.2
    - types-colorama
    - types-Pillow
    - types-Pygments
    - types-pytz
    - types-setuptools
    args:
    - --python-version=3.11
    - --txt-report=.tox/.tmp/.test-results/mypy--py-3.11
    - --cobertura-xml-report=.tox/.tmp/.test-results/mypy--py-3.11
    - --html-report=.tox/.tmp/.test-results/mypy--py-3.11
    pass_filenames: false
  - id: mypy
    alias: mypy-py39
    name: MyPy, for Python 3.9
    additional_dependencies:
    - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
    - pytest
    - Sphinx >= 3.1.2
    - types-colorama
    - types-Pillow
    - types-Pygments
    - types-pytz
    - types-setuptools
    args:
    - --python-version=3.9
    - --txt-report=.tox/.tmp/.test-results/mypy--py-3.9
    - --cobertura-xml-report=.tox/.tmp/.test-results/mypy--py-3.9
    - --html-report=.tox/.tmp/.test-results/mypy--py-3.9
    pass_filenames: false

- repo: https://github.com/PyCQA/pylint.git
  rev: v3.3.2
  hooks:
  - id: pylint
    additional_dependencies:
    - covdefaults  # needed by pylint-pytest due to pytest-cov loading coverage
    - pylint-pytest ~= 2.0.0a0
    - pytest
    - pytest-cov  # needed by pylint-pytest since it picks up pytest's args
    - pytest-xdist  # needed by pylint-pytest since it picks up pytest's args
    - setuptools-scm  # docs
    - sphinx
    - towncrier >= 23

...