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

default_language_version = { python = "python3.13" }

[[repos]]
repo = "meta"
hooks = [
  # ensures that exclude directives apply to any file in the repository.
  { id = "check-useless-excludes" },
  # ensures that the configured hooks apply to at least one file in the repository.
  { id = "check-hooks-apply" }
]

# Built-in hooks reimplemented in Rust by prek. No repo clone or environment setup required.
[[repos]]
repo = "builtin"
hooks = [
  # Prevents commits to certain branches
  {
    id = "no-commit-to-branch",
    args = [
      "--branch",
      "main",
      "--branch",
      "master"
    ]
  },
  # Checks that large files have not been added. Default cut-off for "large" files is 500kb.
  { id = "check-added-large-files" },
  # Checks for filenames that will conflict on case insensitive filesystems (the majority of Windows filesystems, most of the time)
  { id = "check-case-conflict" },
  # Checks for artifacts from resolving merge conflicts.
  { id = "check-merge-conflict" },
  # Removes trailing whitespace.
  {
    id = "trailing-whitespace",
    types_or = [
      "python",
      "c",
      "c++",
      "batch",
      "markdown",
      "toml",
      "yaml",
      "powershell"
    ]
  },
  # Ensures all files end in 1 (and only 1) newline.
  {
    id = "end-of-file-fixer",
    types_or = [
      "python",
      "c",
      "c++",
      "batch",
      "markdown",
      "toml",
      "yaml",
      "powershell"
    ]
  },
  # Removes the UTF-8 BOM from files that have it.
  # See https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/codingStandards.md#encoding
  {
    id = "fix-byte-order-marker",
    types_or = [
      "python",
      "c",
      "c++",
      "batch",
      "markdown",
      "toml",
      "yaml",
      "powershell"
    ]
  },
  # Validates TOML files.
  { id = "check-toml" },
  # Validates YAML files.
  { id = "check-yaml" },
  # Ensures that links to lines in files under version control point to a particular commit.
  { id = "check-vcs-permalinks" }
]

# These hooks use the upstream repo rather than prek's builtin equivalents:
# - check-ast and debug-statements have no builtin implementation.
# - The builtin check-illegal-windows-names only matches files that already have illegal names,
#   so check-hooks-apply reports it as unused on a clean repo; the upstream hook checks all files.
[[repos]]
repo = "https://github.com/pre-commit/pre-commit-hooks"
rev = "v5.0.0"
hooks = [
  # Checks python syntax
  { id = "check-ast" },
  # Checks Python files for debug statements, such as python's breakpoint function, or those inserted by some IDEs.
  { id = "debug-statements" },
  # Avoids using reserved Windows filenames.
  { id = "check-illegal-windows-names" }
]

[[repos]]
repo = "https://github.com/asottile/add-trailing-comma"
rev = "v3.2.0"
hooks = [
  # Ruff preserves indent/new-line formatting of function arguments, list items, and similar iterables,
  # if a trailing comma is added.
  # This adds a trailing comma to args/iterable items in case it was missed.
  { id = "add-trailing-comma" }
]

[[repos]]
# Keep in sync with the pinned Ruff version in pyproject.toml.
repo = "https://github.com/astral-sh/ruff-pre-commit"
rev = "v0.14.5"
hooks = [
  {
    id = "ruff",
    name = "lint with ruff",
    args = ["--fix"]
  },
  {
    id = "ruff-format",
    name = "format with ruff"
  }
]

[[repos]]
repo = "local"
hooks = [
  {
    id = "pyright",
    name = "type check with pyright",
    entry = "uv run pyright",
    language = "system",
    types = ["python"]
  }
]