pre-commit-config.yaml

exclude: '^$|settings|scripts|vendor|\.(min\.js|svg)$|static/.*\.js$'
fail_fast: false
repos:

- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v4.4.0
  hooks:
    # Disabled because yapf is better for our purpose
    # - id: autopep8-wrapper
    - id: check-added-large-files
    - id: check-ast
    - id: check-case-conflict
    - id: check-executables-have-shebangs
    - id: check-json
    - id: check-shebang-scripts-are-executable
    - id: check-toml
    - id: check-vcs-permalinks
    - id: debug-statements
    - id: fix-byte-order-marker
    - id: end-of-file-fixer
    - id: fix-encoding-pragma
      exclude: |
        (?x)^(
            readthedocs/rtd_tests/files/conf.py|
        )$
      args: ['--remove']
    - id: check-merge-conflict
    - id: check-symlinks
    - id: trailing-whitespace
      exclude: |
        (?x)^(
            docs/.+/locale/.*\.po|
            .+\.svg|
            .+\.js|
            .+\.css|
            .*/migrations/.*|
        )$
    - id: mixed-line-ending
      args: ['--fix=lf']

- repo: https://github.com/PyCQA/autoflake
  rev: v2.2.0
  hooks:
    - id: autoflake
      args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']

# TODO: re-enable it and use `--range` to select the modified lines
# - repo: https://github.com/myint/docformatter.git
#   rev: v1.4
#   hooks:
#     - id: docformatter
#       args: ['--in-place', '--wrap-summaries=80', '--wrap-descriptions=80', '--pre-summary-newline']

- repo: https://github.com/adamchainz/django-upgrade
  rev: "1.14.1"
  hooks:
  - id: django-upgrade
    args: [--target-version, "4.2"]

- repo: https://github.com/psf/black
  rev: 23.7.0
  hooks:
    - id: black
      # It is recommended to specify the latest version of Python
      # supported by your project here, or alternatively use
      # pre-commit's default_language_version, see
      # https://pre-commit.com/#top_level-default_language_version
      language_version: python3.10
      exclude: |
        (?x)^(
            readthedocs/rtd_tests/files/conf.py|
            .*/migrations/.*
        )$

# NOTE: run `isort` after `black` to keep the format of isort finally
- repo: https://github.com/pycqa/isort
  rev: 5.12.0
  hooks:
    - id: isort
      name: isort (python)
      exclude: |
        (?x)^(
            .*/migrations/.*
        )

- repo: https://github.com/asottile/blacken-docs
  rev: 1.16.0
  hooks:
    - id: blacken-docs
      additional_dependencies: [black==23.7.0]

- repo: https://github.com/PyCQA/prospector
  rev: 1.10.2
  hooks:
    - id: prospector
      args:
        - --profile=prospector.yml
        - --die-on-tool-error
      exclude: |
        (?x)^(
            docs/.*|
            common/.*|
            .*/settings/.*|
            .*/rtd_tests/.*|
            .*/tests/.*|
            .*/migrations/.*
        )$
      # This PYTHONPATH environment variable is required for readthedocs-corporate when running `tox -e pre-commit`
      entry: env PYTHONPATH=readthedocs:../readthedocs.org:./ DJANGO_SETTINGS_MODULE=readthedocs.settings.test prospector
      # We have to install the dependencies from an URL since we don't have access to this file easily from pre-commit
      additional_dependencies:
        - -r
        - https://raw.githubusercontent.com/readthedocs/readthedocs.org/main/requirements/testing.txt

- repo: https://github.com/aspiredu/django-safemigrate
  rev: "4.2"
  hooks:
    - id: check