.pre-commit-config.yaml

fail_fast: true
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      # - id: check-docstring-first
      - id: check-json
      - id: check-yaml
      - id: pretty-format-json
        exclude: \.ipy(n|nb)$
        args: ["--autofix", "--indent=2", "--no-sort-keys"]

  - 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

  - repo: https://github.com/PyCQA/isort
    rev: 5.12.0
    hooks:
      - id: isort

  - repo: https://github.com/psf/black
    rev: 23.7.0
    hooks:
    - id: black


  # - repo: https://github.com/PyCQA/flake8
  #   rev: 6.0.0
  #   hooks:
  #     - id: flake8
  #       additional_dependencies:
  #         - flake8-black
  #       exclude: .git,__pycache__,build,dist
# 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']

#     # Verify that pyproject.toml is well formed
#   - repo: https://github.com/abravalheri/validate-pyproject
#     rev: v0.12.1
#     hooks:
#       - id: validate-pyproject
#         name: Validate pyproject.toml
#         description: Verify that pyproject.toml adheres to the established schema.


#     # 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 code style and report code that doesn't adhere.
#   - repo: https://github.com/psf/black
#     rev: 23.7.0
#     hooks:
#       - id: black-jupyter
#         name: Format code using black
#         types_or: [python, pyi, jupyter]
#         # 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




#     # 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: bash -c "if python -m pytest --co -qq; then python -m pytest --cov=./src --cov-report=html; fi"
#         language: system
#         pass_filenames: false
#         always_run: 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: sphinx-build
#         language: system
#         always_run: true
#         exclude_types: [file, symlink]
#         args:
#           [
#             "-M", # Run sphinx in make mode, so we can use -D flag later
#                   # Note: -M requires next 3 args to be builder, source, output
#             "html", # Specify builder
#             "./docs", # Source directory of documents
#             "./_readthedocs", # Output directory for rendered documents
#             "-T", # Show full trace back on exception
#             "-E", # Don't use saved env; always read all files
#             "-d", # Flag for cached environment and doctrees
#             "./docs/_build/doctrees", # Directory
#             "-D", # Flag to override settings in conf.py
#             "exclude_patterns=notebooks/*", # Exclude our notebooks from pre-commit
#           ]