prek.toml

# Configuration file for `prek`, a git hook framework written in Rust.
# See https://prek.j178.dev for more information.
#:schema https://www.schemastore.org/prek.json

fail_fast = true
default_install_hook_types = [
  "pre-commit",
  "pre-push"
  ]

[[repos]]
repo = "meta"
hooks = [
  {
    id = "check-useless-excludes",
    stages = ["pre-commit"]
  }
]

[[repos]]
repo = "https://github.com/pre-commit/pre-commit-hooks"
rev = "v6.0.0"
hooks = [
  {
    id = "check-added-large-files",
    stages = ["pre-commit"]
  },
  {
    id = "check-case-conflict",
    stages = ["pre-commit"]
  },
  {
    id = "check-executables-have-shebangs",
    stages = ["pre-commit"]
  },
  {
    id = "check-merge-conflict",
    stages = ["pre-commit"]
  },
  {
    id = "check-shebang-scripts-are-executable",
    stages = ["pre-commit"]
  },
  {
    id = "check-symlinks",
    stages = ["pre-commit"]
  },
  {
    id = "check-json",
    stages = ["pre-commit"]
  },
  {
    id = "check-toml",
    stages = ["pre-commit"]
  },
  {
    id = "check-vcs-permalinks",
    stages = ["pre-commit"]
  },
  {
    id = "check-yaml",
    stages = ["pre-commit"]
  },
  {
    id = "end-of-file-fixer",
    stages = ["pre-commit"]
  },
  {
    id = "file-contents-sorter",
    files = 'spelling_private_dict\.txt$',
    stages = ["pre-commit"]
  },
  {
    id = "trailing-whitespace",
    stages = ["pre-commit"]
  }
]

[[repos]]
repo = "https://github.com/pre-commit/pygrep-hooks"
rev = "v1.10.0"
hooks = [
  {
    id = "rst-directive-colons",
    stages = ["pre-commit"]
  },
  {
    id = "rst-inline-touching-normal",
    stages = ["pre-commit"]
  },
  {
    id = "text-unicode-replacement-char",
    stages = ["pre-commit"]
  },
  {
    id = "rst-backticks",
    stages = ["pre-commit"]
  }
]

[[repos]]
repo = "local"
hooks = [
  {
    id = "actionlint",
    name = "actionlint",
    entry = "uv run --group=dev actionlint",
    language = "python",
    pass_filenames = false,
    types_or = ["yaml"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "pydocstringformatter",
    name = "pydocstringformatter",
    entry = "uv run --group=dev pydocstringformatter",
    language = "python",
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "shellcheck",
    name = "shellcheck",
    entry = "uv run --group=dev shellcheck --shell=bash",
    language = "python",
    types_or = ["shell"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "shellcheck-docs",
    name = "shellcheck-docs",
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=shell --language=console --command="shellcheck --shell=bash"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "shfmt",
    name = "shfmt",
    entry = "uv run --group=dev shfmt --write --space-redirects --indent=4",
    language = "python",
    types_or = ["shell"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "shfmt-docs",
    name = "shfmt-docs",
    entry = 'uv run --group=dev doccmd --language=shell --language=console --skip-marker=shfmt --no-pad-file --command="shfmt --write --space-redirects --indent=4"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "mypy",
    name = "mypy",
    stages = ["pre-push"],
    entry = "uv run --group=dev -m mypy",
    language = "python",
    types_or = [
      "python",
      "toml"
    ],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "mypy-docs",
    name = "mypy-docs",
    stages = ["pre-push"],
    entry = 'uv run --group=dev doccmd --no-write-to-file --language=python --command="mypy"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "check-manifest",
    name = "check-manifest",
    stages = ["pre-push"],
    entry = "uv run --group=dev -m check_manifest",
    language = "python",
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "pyright",
    name = "pyright",
    stages = ["pre-push"],
    entry = "uv run --group=dev -m pyright .",
    language = "python",
    types_or = [
      "python",
      "toml"
    ],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "pyright-docs",
    name = "pyright-docs",
    stages = ["pre-push"],
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=python --command="pyright"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "vulture",
    name = "vulture",
    entry = "uv run --group=dev -m vulture .",
    language = "python",
    types_or = ["python"],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "vulture-docs",
    name = "vulture docs",
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=python --command="vulture"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "pyroma",
    name = "pyroma",
    entry = "uv run --group=dev -m pyroma --min 10 .",
    language = "python",
    pass_filenames = false,
    types_or = ["toml"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "deptry",
    name = "deptry",
    entry = "uv run --group=dev -m deptry src/",
    language = "python",
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "pylint",
    name = "pylint",
    entry = "uv run --group=dev -m pylint *.py src/ tests/ docs/",
    language = "python",
    stages = ["manual"],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "pylint-docs",
    name = "pylint-docs",
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=python --command="pylint"',
    language = "python",
    stages = ["manual"],
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "ruff-check-fix",
    name = "Ruff check fix",
    entry = "uv run --group=dev -m ruff check --fix",
    language = "python",
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "ruff-check-fix-docs",
    name = "Ruff check fix docs",
    entry = 'uv run --group=dev doccmd --language=python --command="ruff check --fix"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "ruff-format-fix",
    name = "Ruff format",
    entry = "uv run --group=dev -m ruff format",
    language = "python",
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "ruff-format-fix-docs",
    name = "Ruff format docs",
    entry = 'uv run --group=dev doccmd --language=python --no-pad-file --command="ruff format"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "strict-kwargs-fix",
    name = "strict-kwargs",
    entry = "uv run --group=dev strict-kwargs check --fix",
    language = "python",
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"],
    require_serial = true
  },
  {
    id = "no-defaults",
    name = "no-defaults",
    entry = "uv run --group=dev no-defaults",
    language = "python",
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"],
    require_serial = true
  },
  {
    id = "doc8",
    name = "doc8",
    entry = "uv run --group=dev -m doc8",
    language = "python",
    types_or = ["rst"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "vale-sync",
    name = "vale sync",
    # The Python Vale wrapper may fail transiently while downloading its binary; see
    # https://github.com/daniperez/vale-python-package/issues/77
    entry = "uv run --group=dev vale sync",
    language = "python",
    pass_filenames = false,
    files = '(\.(rst|md)$|^\.vale\.ini$)',
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "snapper",
    name = "snapper",
    entry = "uv run --group=dev snapper --native --max-width 0 --in-place",
    language = "python",
    types_or = [
      "rst",
      "markdown"
    ],
    require_serial = true,
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "vale",
    name = "vale",
    entry = "uv run --group=dev vale",
    language = "python",
    types_or = [
      "rst",
      "markdown"
    ],
    require_serial = true,
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "interrogate",
    name = "interrogate",
    entry = "uv run --group=dev -m interrogate",
    language = "python",
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "interrogate-docs",
    name = "interrogate docs",
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=python --command="interrogate"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "pyproject-fmt-fix",
    name = "pyproject-fmt",
    entry = "uv run --group=dev pyproject-fmt",
    language = "python",
    types_or = ["toml"],
    files = "pyproject.toml",
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "linkcheck",
    name = "linkcheck",
    entry = "uv run --group=dev sphinx-build -M linkcheck docs/source docs/build -W",
    language = "python",
    types_or = ["rst", "markdown"],
    stages = ["manual"],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "spelling",
    name = "spelling",
    entry = "uv run --group=dev sphinx-build -M spelling docs/source docs/build -W",
    language = "python",
    types_or = ["rst", "markdown"],
    stages = ["manual"],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "docs",
    name = "Build Documentation",
    entry = "uv run --group=dev sphinx-build -M html docs/source docs/build -W",
    language = "python",
    stages = ["manual"],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "pyright-verifytypes",
    name = "pyright-verifytypes",
    stages = ["pre-push"],
    entry = "uv run --group=dev -m pyright --verifytypes vws",
    language = "python",
    pass_filenames = false,
    types_or = ["python"],
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "ty",
    name = "ty",
    stages = ["pre-push"],
    entry = "uv run --group=dev ty check",
    language = "python",
    types_or = [
      "python",
      "toml"
    ],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "ty-docs",
    name = "ty-docs",
    stages = ["pre-push"],
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=python --command="ty check"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "yamlfix",
    name = "yamlfix",
    entry = "uv run --group=dev yamlfix",
    language = "python",
    types_or = ["yaml"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "zizmor",
    name = "zizmor",
    entry = "uv run --group=dev zizmor --strict-collection .github",
    language = "python",
    pass_filenames = false,
    types_or = ["yaml"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "sphinx-lint",
    name = "sphinx-lint",
    entry = "uv run --group=dev sphinx-lint --enable=all --disable=line-too-long",
    language = "python",
    types_or = ["rst"],
    additional_dependencies = ["uv==0.11.7"],
    stages = ["pre-commit"]
  },
  {
    id = "pyrefly",
    name = "pyrefly",
    stages = ["pre-push"],
    entry = "uv run --group=dev pyrefly check",
    language = "python",
    types_or = [
      "python",
      "toml"
    ],
    pass_filenames = false,
    additional_dependencies = ["uv==0.11.7"]
  },
  {
    id = "pyrefly-docs",
    name = "pyrefly-docs",
    stages = ["pre-push"],
    entry = 'uv run --group=dev doccmd --no-write-to-file --example-workers 0 --language=python --command="pyrefly check"',
    language = "python",
    types_or = [
      "markdown",
      "rst"
    ],
    additional_dependencies = ["uv==0.11.7"]
  }
]