feat(dev): use prek instead of pre-commit (#1380)

Signed-off-by: arielle <[email protected]>
Co-authored-by: vi <[email protected]>

Author: onerandomusername

.github/workflows/lint-test.yml

@@ -114,20 +114,24 @@ jobs:
 
   lint:
     runs-on: ubuntu-latest
+    env:
+      RUFF_OUTPUT_FORMAT: github
     steps:
+
       - uses: actions/checkout@v4
 
-      - name: Cache pre-commit
+      - name: Cache pip cache
         uses: actions/cache@v4
         with:
-          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+          key: ${{ runner.os }}-prek-pip-${{ hashFiles('**/pyproject.toml') }}
           path: ~/.cache/pip
 
-      - name: Run pre-commit
-        id: pre-commit
-        uses: pre-commit/[email protected]
-        env:
-          RUFF_OUTPUT_FORMAT: github
+      - name: Run prek
+        id: prek
+        uses: j178/[email protected]
+        # given the interoperability and the nature of prek, we stay unpinned for now
+        # note that this action by default uses the latest version of prek
+        # this is exactly how the pre-commit action worked, and we never had any issues
 
   docs:
     # unlike the other workflows, we explicitly use the same version as

.pre-commit-config.yaml

@@ -1,9 +1,8 @@
 # SPDX-License-Identifier: MIT
 
-## Pre-commit setup
-
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
+    # note that this version is ignored by prek when using the fastpath
     rev: v5.0.0
     hooks:
       - id: check-case-conflict

CONTRIBUTING.md

@@ -8,20 +8,21 @@ The following is a set of guidelines for contributing to the repository. These a
 
 ## Table of Contents
 
-- [Table of Contents](#table-of-contents)
-- [This is too much to read! I want to ask a question!](#this-is-too-much-to-read-i-want-to-ask-a-question)
-- [Good Bug Reports](#good-bug-reports)
-- [Creating a Pull Request](#creating-a-pull-request)
-  - [Overview](#overview)
-  - [Initial setup](#initial-setup)
-  - [Commit/PR Naming Guidelines](#commitpr-naming-guidelines)
-  - [Formatting](#formatting)
-  - [Pyright](#pyright)
-  - [Changelogs](#changelogs)
-  - [Documentation](#documentation)
-- [Migrating development environments](#migrating-development-environments)
-  - [Migrating from `pdm` to `uv`](#migrating-from-pdm-to-uv)
-  - [Migrating `pdm`'s scripts to `nox`](#migrating-pdms-scripts-to-nox)
+- [Contributing to disnake](#contributing-to-disnake)
+  - [Table of Contents](#table-of-contents)
+  - [This is too much to read! I want to ask a question!](#this-is-too-much-to-read-i-want-to-ask-a-question)
+  - [Good Bug Reports](#good-bug-reports)
+  - [Creating a Pull Request](#creating-a-pull-request)
+    - [Overview](#overview)
+    - [Initial setup](#initial-setup)
+    - [Commit/PR Naming Guidelines](#commitpr-naming-guidelines)
+    - [Formatting](#formatting)
+    - [Pyright](#pyright)
+    - [Changelogs](#changelogs)
+    - [Documentation](#documentation)
+  - [Migrating development environments](#migrating-development-environments)
+    - [Migrating from `pdm` to `uv`](#migrating-from-pdm-to-uv)
+    - [Migrating `pdm`'s scripts to `nox`](#migrating-pdms-scripts-to-nox)
 
 ## This is too much to read! I want to ask a question!
 
@@ -83,7 +84,7 @@ This will:
 - create `uv.lock`
 - create a venv at `.venv`
 - install all dependencies to `.venv`
-- install pre-commit hooks at `.git/hooks/pre-commit`
+- install pre-commit hooks (via prek) at `.git/hooks/pre-commit`
 
 Other tools used in this project include [ruff](https://docs.astral.sh/ruff) (formatter and linter), and [pyright](https://microsoft.github.io/pyright/#/) (type-checker). For the most part, these automatically run on every commit with no additional action required - see below for details.
 
@@ -113,9 +114,9 @@ Details about the specific commit types can be found on the [conventional commit
 
 This project follows PEP-8 guidelines (mostly) with a column limit of 100 characters, and uses the tools mentioned above to enforce a consistent coding style.
 
-The installed [`pre-commit`](https://pre-commit.com/) hooks will automatically run before every commit, which will format/lint the code
+The installed [`prek`](https://github.com/j178/prek) hooks will automatically run before every commit, which will format/lint the code
 to match the project's style. Note that you will have to stage and commit again if anything was updated!  
-Most of the time, running pre-commit will automatically fix any issues that arise.
+Most of the time, running prek will automatically fix any issues that arise.
 
 ### Pyright
 
@@ -182,4 +183,4 @@ $ nox -s dev
 ```
 
 > [!TIP]
-> To provide arguments to the selected sessions with `nox`, pass them **after** `--`. For example, to tell `pre-commit` to only run `ruff format`, run `nox -s lint -- ruff-format`.
+> To provide arguments to the selected sessions with `nox`, pass them **after** `--`. For example, to tell `prek` to only run `ruff format`, run `nox -s lint -- ruff-format`.

noxfile.py

@@ -247,7 +247,7 @@ def docs(session: nox.Session) -> None:
 def lint(session: nox.Session) -> None:
     """Check all paths for linting errors"""
     install_deps(session)
-    session.run("pre-commit", "run", "--all-files", *session.posargs)
+    session.run("prek", "run", "--all-files", *session.posargs)
 
 
 @nox.session(name="check-manifest")
@@ -466,12 +466,12 @@ def dev(session: nox.Session) -> None:
     - lock all dependencies with pdm
     - create a .venv/ directory, overwriting the existing one,
     - install all dependencies needed for development.
-    - install the pre-commit hook
+    - install the pre-commit hook (prek)
     """
     session.run("uv", "lock", external=True)
     session.run("uv", "venv", "--clear", external=True)
     session.run("uv", "sync", "--all-extras", "--all-groups", external=True)
-    session.run("uv", "run", "pre-commit", "install", external=True)
+    session.run("uv", "run", "prek", "install", "--overwrite", external=True)
 
 
 if __name__ == "__main__":

pyproject.toml

@@ -85,7 +85,7 @@ ruff = [
     "ruff==0.13.0",
 ]
 tools = [
-    "pre-commit~=3.0",
+    "prek>=0.2.0",
     "slotscheck~=0.16.4",
     "check-manifest==0.49",
     { include-group = "ruff" },