.pre-commit-config.yaml

ci:
    autofix_prs: false
    autoupdate_schedule: quarterly
repos:
        - repo: https://github.com/pre-commit/pre-commit-hooks
          rev: v5.0.0
          hooks:
                - id: check-yaml
                - id: end-of-file-fixer
                  exclude: \.txt$
                - id: trailing-whitespace  # Remove trailing whitespaces
                - id: check-merge-conflict

        # Fix common spelling mistakes
        - repo: https://github.com/codespell-project/codespell
          rev: v2.3.0
          hooks:
                - id: codespell
                  args: [
                    '--ignore-words-list', 'nd,alos,inout,theses',
                    '--ignore-regex', '\bhist\b',
                    '--'
                  ]
                  types_or: [python, rst, markdown]
                  files: ^(xdem|doc|tests)/

        # Replace relative imports (e.g. 'from . import georaster' -> 'from geoutils import georaster')
        - repo: https://github.com/MarcoGorelli/absolufy-imports
          rev: v0.3.1
          hooks:
                - id: absolufy-imports

        # Format the code aggressively using black
        - repo: https://github.com/psf/black
          rev: 24.10.0
          hooks:
                  - id: black
                    args: [--line-length=120]

        # Lint the code using flake8
        - repo: https://github.com/pycqa/flake8
          rev: 7.1.1
          hooks:
                - id: flake8
                  # More than one argument in the second list, so need to pass arguments as below (and -- to finish)
                  args: [
                          '--max-line-length', '120',  # we can write dicts however we want
                          '--extend-ignore', 'E203,C408,B028', # flake8 disagrees with black, so this should be ignored.
                          '--'
                  ]
                  additional_dependencies:
                          - flake8-comprehensions
                          - flake8-bugbear
                  files: ^(xdem|tests)

        # Lint the code using mypy
        - repo: https://github.com/pre-commit/mirrors-mypy
          rev: v1.13.0
          hooks:
                - id: mypy
                  args: [
                        --config-file=mypy.ini,
                        --strict,
                        --implicit-optional,
                        --ignore-missing-imports,  # Don't warn about stubs since pre-commit runs in a limited env
                        --allow-untyped-calls,  # Dynamic function/method calls are okay. Untyped function definitions are not okay.
                        --show-error-codes,
                        --no-warn-unused-ignores,  # Ignore 'type: ignore' comments that are not used.
                        --disable-error-code=attr-defined,  # "Module has no attribute 'XXX'" occurs because of the pre-commit env.
                        --disable-error-code=name-defined,  # "Name 'XXX' is not defined" occurs because of the pre-commit env.
                        --disable-error-code=var-annotated,
                        --disable-error-code=no-any-return

                  ]
                  additional_dependencies: [tokenize-rt==3.2.0, numpy==1.26]
                  files: ^(xdem|tests|doc/code)


        # Sort imports using isort
        - repo: https://github.com/PyCQA/isort
          rev: 5.13.2
          hooks:
                  - id: isort
                    args: ["--profile", "black"]

        # Automatically upgrade syntax to a minimum version
        - repo: https://github.com/asottile/pyupgrade
          rev: v3.19.0
          hooks:
                - id: pyupgrade
                  args: [--py37-plus]

        # Various formattings
        - repo: https://github.com/pre-commit/pygrep-hooks
          rev: v1.10.0
          hooks:
                # Single backticks should apparently not be used
                - id: rst-backticks
                # Check that all directives end with double colon
                - id: rst-directive-colons
                  types: [text]
                  types_or: [python, rst]
                # Inline code should not touch normal text
                - id: rst-inline-touching-normal
                  types: [text]
                  types_or: [python, rst]
                # Eval should never be used (can do arbitrary code execution)
                - id: python-no-eval
                # Enforce the use of type annotations instead of docstring type comments
                - id: python-use-type-annotations

        # Add custom regex lints (see .relint.yml)
        - repo: https://github.com/codingjoe/relint
          rev: 3.3.1
          hooks:
                - id: relint
        - repo: local
          hooks:
                # Generate pip's requirements.txt from conda's environment.yml to ensure consistency
                - id: pip-to-conda
                  name: Generate pip dependency from conda
                  language: python
                  entry: .github/scripts/generate_pip_deps_from_conda.py
                  files: ^(environment.yml|requirements.txt)$
                  pass_filenames: false
                  additional_dependencies: [tomli, pyyaml]

        # Add license header to the source files
        - repo: local
          hooks:
            - id: add-license-header
              name: Add License Header
              entry: python .github/scripts/apply_license_header.py
              language: python
              files: \.py$