# 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: quarterly

autoupdate_commit_msg: "chore: update pre-commit hooks"

autofix_commit_msg: "style: pre-commit fixes"

# pysentry downloads advisory databases at run time, and pre-commit.ci

# runs hooks without network access, so it runs locally and in security.yml.

# zizmor does run on pre-commit.ci, offline, which skips its online audits;

# security.yml runs those.

skip: [pylint, no-commit-to-branch, pysentry]

fail_fast: false

default_language_version:

python: python3

repos:

- repo: https://github.com/pre-commit/pre-commit-hooks

rev: v6.0.0

hooks:

- id: check-added-large-files

- id: check-case-conflict

- id: check-executables-have-shebangs

- id: check-illegal-windows-names

- id: check-merge-conflict

- id: check-ast

- id: check-json # no JSON files yet; enabled for the future

- id: check-toml

- id: check-yaml

- id: check-vcs-permalinks

- id: debug-statements

- id: destroyed-symlinks

- id: detect-private-key

- id: forbid-submodules

- id: end-of-file-fixer

exclude_types: [svg]

- id: mixed-line-ending

- id: trailing-whitespace

- id: name-tests-test

args: ["--pytest-test-first"]

- repo: https://github.com/abravalheri/validate-pyproject

rev: v0.27

hooks:

- id: validate-pyproject

name: Validate pyproject.toml

# I don't yet trust ruff to do what autoflake does

- repo: https://github.com/PyCQA/autoflake

rev: v2.4.0

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: 9.0.2

hooks:

- id: isort

# Let's keep `pyupgrade` even though `ruff --fix` probably does most of it

- repo: https://github.com/asottile/pyupgrade

rev: v3.22.0

hooks:

- id: pyupgrade

args: [--py311-plus]

- repo: https://github.com/MarcoGorelli/auto-walrus

rev: 0.4.1

hooks:

- id: auto-walrus

args: [--line-length, "100"]

- repo: https://github.com/psf/black-pre-commit-mirror

rev: 26.10.1

hooks:

- id: black

- id: black-jupyter

- repo: https://github.com/astral-sh/ruff-pre-commit

rev: v0.17.3

hooks:

- id: ruff-check

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: 7.5.0

hooks:

- id: flake8

args: ["--config=.flake8"]

additional_dependencies:

&flake8_dependencies # These versions need updated manually

- flake8==7.5.0

- flake8-bugbear==26.10.27

- flake8-simplify==0.31.1

- repo: https://github.com/codespell-project/codespell

rev: v2.4.3

hooks:

- id: codespell

types_or: [python, markdown, rst, toml, yaml]

additional_dependencies:

- tomli; python_version<'3.11'

files: ^(graphblas|docs)/

- repo: https://github.com/astral-sh/ruff-pre-commit

rev: v0.17.3

hooks:

- id: ruff-check

# - id: ruff-format # we prefer black; uncomment to compare with ruff's formatter

- repo: https://github.com/sphinx-contrib/sphinx-lint

rev: v1.0.2

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

# 5.1 is still in beta (5.1b2) and a pre-release pin defeats pre-commit.ci's

# autoupdate "avoid prereleases" logic; stay on 5.0.1 until 5.1 GAs.

rev: "5.0.1"

hooks:

- id: pyroma

args: [-n, "10", .]

- repo: https://github.com/shellcheck-py/shellcheck-py

rev: "v0.11.0.1-1"

hooks:

- id: shellcheck

- repo: https://github.com/rbubley/mirrors-prettier

rev: v3.9.10

hooks:

- id: prettier

args: [--prose-wrap=preserve]

- repo: https://github.com/pre-commit/pygrep-hooks

rev: v1.10.0

hooks:

- id: rst-backticks

- id: rst-directive-colons

- id: rst-inline-touching-normal

- id: python-check-blanket-noqa

- id: python-check-blanket-type-ignore

- id: python-no-eval

- id: python-no-log-warn

- id: text-unicode-replacement-char

- repo: https://github.com/ComPWA/taplo-pre-commit

rev: v0.9.3

hooks:

- id: taplo-format

args: ["--option", "column_width=100"]

- repo: https://github.com/rhysd/actionlint

rev: v1.7.12

hooks:

- id: actionlint

- repo: https://github.com/zizmorcore/zizmor-pre-commit

rev: v1.32.0

hooks:

- id: zizmor

- repo: https://github.com/python-jsonschema/check-jsonschema

rev: 0.39.0

hooks:

- id: check-dependabot

- id: check-github-workflows

- id: check-readthedocs

- repo: https://github.com/adrienverge/yamllint

rev: v1.38.0

hooks:

- id: yamllint

- repo: https://github.com/pysentry/pysentry-pre-commit

rev: v0.5.0

hooks:

- id: pysentry

# Run when pyproject.toml or this file changes rather than at every commit, where

# it fails offline. security.yml also runs it weekly.

always_run: false

files: ^(pyproject\.toml|\.pre-commit-config\.yaml)$

# Audit the floors in pyproject.toml. Without `--direct-only`, pysentry resolves the

# newest versions with uv (which the hook installs), and no longer sees a floor that

# allows a vulnerable release.

args:

- --format=human

- --fail-on=low

- --sources=pypa,osv,pypi

- --direct-only

- repo: meta

hooks:

- id: check-hooks-apply

- id: check-useless-excludes

- repo: local

hooks:

- id: disallow-caps

name: Disallow improper capitalization

language: pygrep

entry: PyBind|Numpy\>|Cmake|CCache|Github|PyTest|\<RST\>|PyLint

exclude: (.pre-commit-config.yaml|docs/pages/guides/style\.md)$

- id: disallow-words

name: Disallow certain words

language: pygrep

entry: "[Ff]alsey"

exclude: .pre-commit-config.yaml$

- id: disallow-bad-permalinks

name: Disallow _ in permalinks

language: pygrep

entry: "^permalink:.*_.*"

- id: disallow-ai-dashes

# AI-ism: em-dash, en-dash, " -- " separator, or "word--jam".

# See ``scripts/find_aiisms.sh`` for the manual / branch-diff variant

# and ``ai/CLAUDE.md`` "Writing Style" for the rationale.

name: Disallow em/en-dash and ' -- ' as a separator

language: pygrep

entry: "—|–| -- |[A-Za-z0-9]--"

types_or: [python, rst, markdown, toml, yaml, shell]

# README intentionally uses en-dash. docs/conf.py + jit_diagnostics.py

# use ``# --- Section ---`` banner comments / print output, which the

# regex also matches. find_aiisms.sh contains the matching regex.

exclude: |

(?x)^(

README\.md

| docs/conf\.py

| scripts/jit_diagnostics\.py

| scripts/find_aiisms\.sh

| \.pre-commit-config\.yaml

)$

# Stress-tests every combination the CI dependency picker can produce against

# the constraints it documents. ~3s for 160k combinations, and it only runs

# when the picker itself changes.

- id: ci-pick-versions

name: Validate CI dependency version picker

entry: python scripts/ci_pick_versions.py --validate

language: system

files: ^scripts/ci_pick_versions\.py$

pass_filenames: false

# 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: v6.0.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.8.2

# hooks:

# - id: bandit

# args: ["-c", "pyproject.toml"]

# additional_dependencies: ["bandit[toml]"]

#

# blacken-docs, blackdoc, mypy, pydocstringformatter, velin, flynt