docs: mention prek (#696)

* docs: mention prek

Signed-off-by: Henry Schreiner <[email protected]>

* chore: support running with prek

Signed-off-by: Henry Schreiner <[email protected]>

* fix: also mention prek in the CONTRIBUTING.md

Signed-off-by: Henry Schreiner <[email protected]>

* chore: move noxfiles to using prek

Signed-off-by: Henry Schreiner <[email protected]>

---------

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.prekignore

@@ -0,0 +1 @@
+/*cookiecutter*/

docs/pages/guides/style.md

@@ -13,15 +13,39 @@ custom_title: Style and static checks
 
 ## Pre-commit
 
-{% rr PY006 %} Scientific Python projects often use [pre-commit][] to check code
-style. It can be installed through `brew` (macOS) or `pip` (anywhere). There are
-two modes to use it locally; you can check manually with `pre-commit run`
-(changes only) or `pre-commit run --all-files` (all). You can also run
+{% rr PY006 %} Scientific Python projects often use [pre-commit][] (or [prek][])
+to check code style. The original, `pre-commit`, has support for more languages,
+but `prek` is a faster Rust rewrite that supports most real world usage.
+
+{% tabs runner %} {% tab pre-commit Pre-commit %}
+
+Pre-commit can be installed through `brew` (macOS) or `pipx/uv` (anywhere).
+There are two modes to use it locally; you can check manually with
+`pre-commit run` (changes only) or `pre-commit run -a` (all). You can also run
 `pre-commit install` to add checks as a git pre-commit hook (which is where it
-gets its name). It's worth trying, even if you've tried and failed to set up a
-custom pre-commit hook before; it's quite elegant and does not add or commit the
-changes, it just makes the changes and allows you to check and add them. You can
-always override the hook with `-n`.
+gets its name).
+
+Pre-commit's setup is much slower than prek, but you can install `pre-commit-uv`
+with pre-commit to speed up the setup time quite a bit.
+
+{% endtab %} {% tab prek Prek %}
+
+Prek can be installed through `brew` (macOS) or `pipx/uv` (anywhere). There are
+two modes to use it locally; you can check manually with `prek run` (hanges
+only) or `prek run -a` (all). You can omit the `run`, as well; such as
+`prek -a`. You can also run `prek install` to add checks as a git pre-commit
+hook.
+
+{% endtab %} {% endtabs %}
+
+Local runs (with `-a`) are the standard way to use it. That will run all the
+checks in optimized, isolated environments. After the first run, it's quite fast
+(either pre-commit or prek).
+
+It's worth trying the install command, even if you've tried and failed to set up
+a custom pre-commit hook before; it's quite elegant and does not add or commit
+the changes, it just makes the changes and allows you to check and add them. You
+can always override the hook with `-n`.
 
 [pre-commit]: https://pre-commit.com
 

docs/pages/guides/tasks.md

@@ -170,8 +170,8 @@ will likely look similar across different projects:
 
 #### Lint
 
-Ideally, all developers should be using pre-commit directly, but this helps new
-users.
+Ideally, all developers should be using pre-commit or prek directly, but this
+helps new users.
 
 <!-- [[[cog
 with code_fence("python"):
@@ -184,9 +184,9 @@ def lint(session: nox.Session) -> None:
     """
     Run the linter.
     """
-    session.install("pre-commit")
+    session.install("prek")
     session.run(
-        "pre-commit", "run", "--all-files", "--show-diff-on-failure", *session.posargs
+        "prek", "run", "--all-files", "--show-diff-on-failure", *session.posargs
     )
 ```
 <!-- prettier-ignore-end -->

noxfile.py

@@ -202,15 +202,15 @@ def diff_files(p1: Path, p2: Path) -> bool:
 @nox.parametrize("vcs", [False, True], ids=["novcs", "vcs"])
 @nox.parametrize("backend", BACKENDS, ids=BACKENDS)
 def lint(session: nox.Session, backend: str, vcs: bool, docs: Docs) -> None:
-    session.install("cookiecutter", "pre-commit")
+    session.install("cookiecutter", "prek")
 
     tmp_dir = session.create_tmp()
     session.cd(tmp_dir)
     cookie = make_cookie(session, backend, vcs, docs)
     session.chdir(cookie)
 
     session.run(
-        "pre-commit",
+        "prek",
         "run",
         "--all-files",
         "--hook-stage=manual",
@@ -221,14 +221,14 @@ def lint(session: nox.Session, backend: str, vcs: bool, docs: Docs) -> None:
 @nox.session(default=False)
 @nox.parametrize("backend", BACKENDS, ids=BACKENDS)
 def autoupdate(session: nox.Session, backend: str) -> None:
-    session.install("cookiecutter", "pre-commit")
+    session.install("cookiecutter", "prek")
 
     tmp_dir = session.create_tmp()
     session.cd(tmp_dir)
     cookie = make_cookie(session, backend, True, Docs.Sphinx)
     session.chdir(cookie)
 
-    session.run("pre-commit", "autoupdate")
+    session.run("prek", "autoupdate")
     session.run("git", "diff", "--exit-code", external=True)
 
 
@@ -419,14 +419,14 @@ def compare_cruft(session):
 @nox.session(reuse_venv=True, default=False)
 def pc_bump(session: nox.Session) -> None:
     """
-    Bump the pre-commit versions.
+    Bump the prek versions.
     """
     session.install("lastversion>=3.4")
     versions = {}
     pages = [
         Path("docs/pages/guides/style.md"),
-        Path("{{cookiecutter.project_name}}/.pre-commit-config.yaml"),
-        Path(".pre-commit-config.yaml"),
+        Path("{{cookiecutter.project_name}}/.prek-config.yaml"),
+        Path(".prek-config.yaml"),
     ]
 
     for page in pages:
@@ -548,8 +548,8 @@ def rr_lint(session: nox.Session) -> None:
     """
     Run the linter.
     """
-    session.install("pre-commit")
-    session.run("pre-commit", "run", "--all-files", *session.posargs)
+    session.install("prek")
+    session.run("prek", "run", "--all-files", *session.posargs)
 
 
 @nox.session
@@ -558,7 +558,7 @@ def rr_pylint(session: nox.Session) -> None:
     Run Pylint.
     """
     # This needs to be installed into the package environment, and is slower
-    # than a pre-commit check
+    # than a prek check
     session.install("-e.[cli]", "pylint")
     session.run("pylint", "src", *session.posargs)
 

{{cookiecutter.project_name}}/.github/CONTRIBUTING.md

@@ -35,8 +35,8 @@ uv sync
 
 # Pre-commit
 
-You should prepare pre-commit, which will help you by checking that commits pass
-required checks:
+You should prepare pre-commit or prek, which will help you by checking that
+commits pass required checks:
 
 ```bash
 uv tool install pre-commit # or brew install pre-commit on macOS

{{cookiecutter.project_name}}/noxfile.py

@@ -20,9 +20,9 @@ def lint(session: nox.Session) -> None:
     """
     Run the linter.
     """
-    session.install("pre-commit")
+    session.install("prek")
     session.run(
-        "pre-commit", "run", "--all-files", "--show-diff-on-failure", *session.posargs
+        "prek", "run", "--all-files", "--show-diff-on-failure", *session.posargs
     )