.pre-commit-config.yaml

fail_fast: true

repos:
    # Compare the local template version to the latest remote template version
    # This hook should always pass. It will print a message if the local version 
    # is out of date.
  - repo: https://github.com/lincc-frameworks/pre-commit-hooks
    rev: v0.1.1
    hooks:
      - id: check-lincc-frameworks-template-version
        name: Check template version
        description: Compare current template version against latest
        verbose: true

    # Clear output from jupyter notebooks so that only the input cells are committed.
  - repo: local
    hooks:
      - id: jupyter-nb-clear-output
        name: Clear output from Jupyter notebooks
        description: Clear output from Jupyter notebooks.
        files: \.ipynb$
        stages: [commit]
        language: system
        entry: jupyter nbconvert --clear-output

    # Prevents committing directly branches named 'main' and 'master'.
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: no-commit-to-branch
        name: Prevent main branch commits
        description: Prevent the user from committing directly to the primary branch.
      - id: check-added-large-files
        name: Check for large files
        description: Prevent the user from committing very large files.
        args: ['--maxkb=500']


    # Automatically sort the imports used in .py files
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
        name: Run isort
        description: Sort and organize imports in .py and .pyi files.
        types_or: [python, pyi]

    # Analyze the src code style and report code that doesn't adhere.
  - repo: local
    hooks:
      - id: pylint
        name: pylint (python files in src/)
        entry: pylint
        language: system
        types: [python]
        files: ^src/
        args:
          [
            "-rn", # Only display messages
            "-sn", # Don't display the score
            "--recursive=y",
            "--rcfile=src/.pylintrc",
          ]

    # Analyze the tests code style and report code that doesn't adhere.
  - repo: local
    hooks:
      - id: pylint
        name: pylint (python files in tests/ and benchmarks/)
        entry: pylint
        language: system
        types: [python]
        files: ^(tests|benchmarks)/
        args:
          [
            "-rn", # Only display messages
            "-sn", # Don't display the score
            "--recursive=y",
            "--rcfile=tests/.pylintrc",
          ]

    # Run unit tests, verify that they pass. Note that coverage is run against
    # the ./src directory here because that is what will be committed. In the 
    # github workflow script, the coverage is run against the installed package
    # and uploaded to Codecov by calling pytest like so:
    # `python -m pytest --cov=<package_name> --cov-report=xml`
  - repo: local
    hooks:
      - id: pytest-check
        name: Run unit tests
        description: Run unit tests with pytest
        entry: tox -e test-cov
        language: system
        pass_filenames: false
        always_run: true
        verbose: true

    # Make sure Sphinx can build the documentation while explicitly omitting 
    # notebooks from the docs, so users don't have to wait through the execution 
    # of each notebook or each commit. By default, these will be checked in the 
    # GitHub workflows.
  - repo: local
    hooks:
      - id: sphinx-build
        name: Build documentation with Sphinx
        entry: tox -e build_docs
        language: system
        always_run: true
        exclude_types: [file, symlink]
        verbose: true