.pre-commit-config.yaml

---

ci:
  autoupdate_schedule: quarterly

repos:
- repo: https://github.com/asottile/add-trailing-comma.git
  rev: v2.4.0
  hooks:
  - id: add-trailing-comma

- repo: https://github.com/PyCQA/isort.git
  rev: 5.12.0
  hooks:
  - id: isort
    args:
    - --honor-noqa
    files: >-
      ^.*\.p(xd|y|yx)$
    types: [file]

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

- repo: https://github.com/pre-commit/pygrep-hooks.git
  rev: v1.9.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.4.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
  - id: detect-private-key

  # Heavy checks:
  - id: check-ast
    exclude: >-
      ^docs/_samples/.*\.py$
  - id: debug-statements
    exclude: >-
      ^docs/_samples/.*\.py$

- repo: https://github.com/PyCQA/pydocstyle.git
  rev: 6.1.1
  hooks:
  - id: pydocstyle
    exclude: >-
      ^docs/_samples/.*\.py$

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

- repo: https://github.com/PyCQA/flake8.git
  rev: 5.0.0
  hooks:
  - id: flake8
    alias: flake8-no-wps
    name: flake8 WPS-excluded
    additional_dependencies:
    - flake8-2020 ~= 1.7.0
    - flake8-length ~= 0.3.0
    - flake8-logging-format ~= 0.7.5
    - flake8-pytest-style ~= 1.6.0
    exclude: >-
      ^docs/_samples/.*\.py$
    files: >-
      ^.*\.p(xd|y|yx)$
    language_version: python3
    types:
    - file

- repo: https://github.com/PyCQA/flake8.git
  # NOTE: This is kept at v4 for until WPS starts supporting flake v5.
  rev: 4.0.1  # enforce-version: 4.0.1
  hooks:
  - id: flake8
    alias: flake8-only-wps
    name: flake8 WPS-only
    args:
    # https://wemake-python-stylegui.de/en/latest/pages/usage/formatter.html
    - --format
    - wemake
    - --select
    - WPS
    additional_dependencies:
    - wemake-python-styleguide ~= 0.17.0
    exclude: >-
      ^docs/_samples/.*\.py$
    files: >-
      ^.*\.p(xd|y|yx)$
    language_version: python3
    types:
    - file

- repo: https://github.com/MarcoGorelli/cython-lint.git
  rev: v0.10.1
  hooks:
  - id: cython-lint
    # NOTE: This linter does not have a config file so it's set up below.
    args:
    - --max-line-length
    - '160'  # matches a similar value in the .flake8 config

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

- repo: local
  hooks:
  - id: changelogs-rst
    name: changelog filenames
    language: fail
    entry: >-
      Changelog files must be named
      ####.(bugfix|feature|deprecation|breaking|doc|misc)(.#)?(.rst)?
    exclude: >-
      (?x)
      ^
        docs/changelog-fragments/(
          \.gitignore
          |\d+\.(
            bugfix
            |feature
            |deprecation
            |breaking
            |doc
            |misc
          )(\.\d+)?(\.rst)?
          |README\.rst
          |template\.j2
        )
      $
    files: ^docs/changelog-fragments/
  - id: changelogs-user-role
    name: Changelog files should use a non-broken :user:`name` role
    language: pygrep
    entry: :user:([^`]+`?|`[^`]+[\s,])
    pass_filenames: true
    types: [file, rst]

# - repo: local
#   hooks:
#   - id: pylint
#     language: system
#     name: PyLint
#     files: \.py$
#     entry: python -m pylint
#     args: []

- repo: local
  hooks:
  - id: enforced-flake8-version
    name: Verify that enforced flake8 version stays unchanged
    description: >-
      This is a sanity check and fixer that makes sure that
      the `flake8` version in this file remains matching the
      corresponding request in the `# enforce-version` comment.
    # Using Python here because using
    # shell test does not always work in CIs:
    entry: >-
      python -c 'import pathlib, re, sys;
      pre_commit_config = pathlib.Path(sys.argv[1]);
      cfg_txt = pre_commit_config.read_text();
      new_cfg_txt = re.sub(
      r"(?P<spaces>\s+)rev:\s(?:\d+\.\d+\.\d+)\s{0,2}"
      r"#\senforce-version:\s(?P<enforced_version>\d+\.\d+\.\d+)"
      r"[ \t\f\v]*",
      r"\g<spaces>rev: \g<enforced_version>  "
      r"# enforce-version: \g<enforced_version>",
      cfg_txt,
      );
      cfg_txt != new_cfg_txt and
      pre_commit_config.write_text(new_cfg_txt)
      '
    pass_filenames: true
    language: system
    files: >-
      ^\.pre-commit-config\.ya?ml$
    types:
    - yaml

...