.pre-commit-config.yaml

# https://pre-commit.com/
#
# Before first use: `pre-commit install`
# To run: `pre-commit run --all-files`
# To update: `pre-commit autoupdate`
#  - &flake8_dependencies below needs updated manually
ci:
    # See: https://pre-commit.ci/#configuration
    autofix_prs: false
    autoupdate_schedule: monthly
    skip: [pylint, no-commit-to-branch]
fail_fast: true
default_language_version:
    python: python3
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: check-added-large-files
      - id: check-ast
      - id: check-toml
      - id: check-yaml
      - id: debug-statements
      - id: end-of-file-fixer
      - id: mixed-line-ending
      - id: trailing-whitespace
  - repo: https://github.com/abravalheri/validate-pyproject
    rev: v0.12.2
    hooks:
      - id: validate-pyproject
        name: Validate pyproject.toml
  # I don't yet trust ruff to do what autoflake does
  - repo: https://github.com/myint/autoflake
    rev: v2.0.2
    hooks:
      - id: autoflake
        args: [--in-place]
  # We can probably remove `isort` if we come to trust `ruff --fix`,
  # but we'll need to figure out the configuration to do this in `ruff`
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
  # Let's keep `pyupgrade` even though `ruff --fix` probably does most of it
  - repo: https://github.com/asottile/pyupgrade
    rev: v3.3.1
    hooks:
      - id: pyupgrade
        args: [--py38-plus]
  - repo: https://github.com/MarcoGorelli/auto-walrus
    rev: v0.2.2
    hooks:
      - id: auto-walrus
        args: [--line-length, "100"]
  - repo: https://github.com/psf/black
    rev: 23.3.0
    hooks:
      - id: black
      - id: black-jupyter
  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: v0.0.261
    hooks:
      - id: ruff
        args: [--fix-only, --show-fixes]
  # Let's keep `flake8` even though `ruff` does much of the same.
  # `flake8-bugbear` and `flake8-simplify` have caught things missed by `ruff`.
  - repo: https://github.com/PyCQA/flake8
    rev: 6.0.0
    hooks:
      - id: flake8
        additional_dependencies: &flake8_dependencies
        # These versions need updated manually
        - flake8==6.0.0
        - flake8-bugbear==23.3.23
        - flake8-simplify==0.20.0
  - repo: https://github.com/asottile/yesqa
    rev: v1.4.0
    hooks:
      - id: yesqa
        additional_dependencies: *flake8_dependencies
  - repo: https://github.com/codespell-project/codespell
    rev: v2.2.4
    hooks:
      - id: codespell
        types_or: [python, rst, markdown]
        additional_dependencies: [tomli]
        files: ^(graphblas|docs)/
  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: v0.0.261
    hooks:
      - id: ruff
  - repo: https://github.com/sphinx-contrib/sphinx-lint
    rev: v0.6.7
    hooks:
      - id: sphinx-lint
        args: [--enable, all, "--disable=line-too-long,leaked-markup"]
  # `pyroma` may help keep our package standards up to date if best practices change.
  # This is probably a "low value" check though and safe to remove if we want faster pre-commit.
  - repo: https://github.com/regebro/pyroma
    rev: "4.2"
    hooks:
      - id: pyroma
        args: [-n, "10", .]
  - repo: local
    hooks:
      # Add `--hook-stage manual` to pre-commit command to run (very slow)
      # It's probably better (and faster!) to simply run `pylint graphblas/some/file.py`
      - id: pylint
        name: pylint
        entry: pylint
        language: system
        types: [python]
        stages: [manual]
        args: [graphblas/]
        pass_filenames: false
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: no-commit-to-branch  # no commit directly to main
#
# Maybe:
#
#  - repo: https://github.com/rstcheck/rstcheck
#    rev: v6.1.1
#    hooks:
#      - id: rstcheck
#        additional_dependencies: [nbsphinx]
#
#  - repo: https://github.com/PyCQA/pydocstyle
#    rev: 6.3.0
#    hooks:
#      - id: pydocstyle
#        additional_dependencies: [tomli]
#
#  - repo: https://github.com/PyCQA/bandit
#    rev: 1.7.4
#    hooks:
#      - id: bandit
#
# blacken-docs, blackdoc mypy, pydocstringformatter, velin, flynt, yamllint