update to use prek

Author: felixgwilliams

.pre-commit-config.yaml

@@ -8,10 +8,10 @@ repos:
     -   id: check-added-large-files
     -   id: check-merge-conflict
 -   repo: https://github.com/crate-ci/typos
-    rev: v1.36.2
+    rev: v1.44.0
     hooks:
     -   id: typos
 -   repo: https://github.com/DavidAnson/markdownlint-cli2
-    rev: v0.18.1
+    rev: v0.21.0
     hooks:
     -   id: markdownlint-cli2

README.md

@@ -1,9 +1,9 @@
 # Python Copier Template for Data Science
 
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
 
 This is a template built with [Copier](https://github.com/copier-org/copier) to generate a data science focused python project.
 
@@ -78,16 +78,22 @@ In addition, the following rules are only enforced for module code as they are i
 
 The target line length is 120 and the docstring convention is google.
 
-### [pre-commit](https://github.com/pre-commit/pre-commit)
+### [prek](https://github.com/j178/prek) and [pre-commit](https://github.com/pre-commit/pre-commit)
 
-pre-commit is a tool that runs checks on your files before you commit them with git, thereby helping ensure code quality.
-Enable it with the following command:
+`prek` and `pre-commit` are tools that run checks on your files before you commit them with git, thereby helping ensure code quality.
+`prek` is faster than `pre-commit` and has more features, including monorepo support.
+
+Depending on your preference, run one of the following commands to set up.
+
+```shell
+prek install --prepare-hooks
+```
 
 ```shell
 pre-commit install --install-hooks
 ```
 
-The configuration is stored in `.pre-commit-config.yaml`.
+The configuration for both is stored in `.pre-commit-config.yaml`.
 
 ### [nbwipers](https://github.com/felixgwilliams/nbwipers)
 

copier.yml

@@ -17,3 +17,8 @@ github_actions:
   type: bool
   help: Add github actions
   default: false
+
+use_prek:
+  type: bool
+  help: Use prek instead of pre-commit
+  default: true

ctt.toml

@@ -5,3 +5,6 @@ project_name = "ctt-test"
 
 [output.".ctt/ga"]
 github_actions = true
+
+[output.".ctt/no-prek"]
+use_prek = false

template/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-merge-conflict
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.6
+    hooks:
+      # Run the linter.
+    -   id: ruff
+        types_or: [python, pyi, jupyter]
+        # Run the formatter.
+    -   id: ruff-format
+        types_or: [python, pyi, jupyter]
+-   repo: https://github.com/felixgwilliams/nbwipers-pre-commit
+    rev: v0.6.1
+    hooks:
+    -   id: nbwipers-check-install
+    -   id: nbwipers-large-files
+-   repo: https://github.com/crate-ci/typos
+    rev: v1.44.0
+    hooks:
+    -   id: typos
+-   repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.21.0
+    hooks:
+    -   id: markdownlint-cli2

template/.pre-commit-config.yaml.jinja

@@ -2,7 +2,7 @@
 
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+{% if use_prek %}[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek){% else %}[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit){% endif %}
 
 Get started by running the following with [just](https://github.com/casey/just):
 

template/README.md.jinja

@@ -11,10 +11,10 @@ setup: install git-setup
 install:
   {% raw %}{{if path_exists("uv.lock") != "true" {"uv sync --all-groups --all-extras --inexact"} else {"uv sync --all-groups --all-extras --locked --inexact"} }}{% endraw %}
 
-# ensure code quality before git commit via pre-commit and nbwipers
+# ensure code quality before git commit via {% if use_prek %}prek{% else %}pre-commit{% endif %} and nbwipers
 git-setup: install
   uv run nbwipers install local
-  uv run pre-commit install --install-hooks
+  {% if use_prek %}uv run prek install --prepare-hooks{% else %}uv run pre-commit install --install-hooks{% endif %}
 
 # run test coverage and create
 test-cov:

template/justfile.jinja

@@ -95,8 +95,8 @@ dev = [
   "nbwipers>=0.6.1",
   "pytest>=8",
   "pytest-cov>=7.0.0",
-  "pre-commit>=4.3.0",
-  "typos>=1.36.2",
+  {% if use_prek %}"prek>=0.3.6"{% else %}"pre-commit>=4.5.1"{% endif %},
+  "typos>=1.44.2",
 ]
 lint = [
   "ruff>=0.13.0",