feat: replace pre-commit with prek (#18)

ritwiktiwari · web-flow · commit a8767c7ddf6d · 2026-01-31T15:08:42.000-08:00
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Built for my own workflow, but you're welcome to use it!
 | **[pytest](https://pytest.org/)** | Testing | Industry standard |
 | **[hatch](https://hatch.pypa.io/)** | Multi-version testing | Matrix testing with envs |
 | **[MkDocs](https://www.mkdocs.org/)** | Documentation | Material theme + mkdocstrings |
-| **[pre-commit](https://pre-commit.com/)** | Git hooks | Code quality enforcement |
+| **[prek](https://prek.dev/)** | Git hooks | Code quality enforcement |
 | **[Typer](https://typer.tiangolo.com/)** | CLI framework | Type-hint based, modern |
 | **[git-cliff](https://git-cliff.org/)** | Changelog | Auto-generated from conventional commits |
 
diff --git a/copier.yml b/copier.yml
@@ -118,9 +118,9 @@ include_docs:
   help: "Include MkDocs documentation?"
   default: true
 
-include_precommit:
+include_prek:
   type: bool
-  help: "Include pre-commit hooks?"
+  help: "Include prek (pre-commit) hooks for code quality checks?"
   default: true
 
 include_codecov:
diff --git a/docs/guide.md b/docs/guide.md
@@ -16,13 +16,13 @@ make install
 source .venv/bin/activate
 ```
 
-### 3. Run the pre-commit hooks
+### 3. Run the prek hooks
 
-If you enabled pre-commit, install the hooks and run them to resolve any initial formatting issues:
+If you enabled prek, install the hooks and run them to resolve any initial formatting issues:
 
 ```bash
-pre-commit install
-uv run pre-commit run -a
+prek install
+uv run prek run -a
 ```
 
 ### 4. Verify everything works
@@ -105,7 +105,7 @@ my-project/
 ├── pyproject.toml           # Single source of truth
 ├── mkdocs.yml               # If docs enabled
 ├── cliff.toml               # Changelog config
-├── .pre-commit-config.yaml  # If pre-commit enabled
+├── .pre-commit-config.yaml  # If prek enabled
 ├── Dockerfile               # If Docker enabled
 ├── .dockerignore            # If Docker enabled
 ├── README.md
diff --git a/docs/index.md b/docs/index.md
@@ -16,7 +16,7 @@ Built for my own workflow, but you're welcome to use it!
 | **[pytest](https://pytest.org/)** | Testing | Industry standard |
 | **[hatch](https://hatch.pypa.io/)** | Multi-version testing | Matrix testing with envs |
 | **[MkDocs](https://www.mkdocs.org/)** | Documentation | Material theme + mkdocstrings |
-| **[pre-commit](https://pre-commit.com/)** | Git hooks | Code quality enforcement |
+| **[prek](https://prek.dev/)** | Git hooks | Code quality enforcement |
 | **[Typer](https://typer.tiangolo.com/)** | CLI framework | Type-hint based, modern |
 | **[git-cliff](https://git-cliff.org/)** | Changelog | Auto-generated from conventional commits |
 
diff --git a/docs/options.md b/docs/options.md
@@ -36,7 +36,7 @@ When you run `copier copy`, you'll be prompted for the following options.
 | `include_github_actions` | bool | `true` | Include GitHub Actions CI/CD |
 | `include_docker` | bool | `true` | Include Dockerfile for containerization |
 | `include_docs` | bool | `true` | Include MkDocs documentation |
-| `include_precommit` | bool | `true` | Include pre-commit hooks |
+| `include_prek` | bool | `true` | Include prek hooks |
 | `include_codecov` | bool | `true` | Include Codecov integration (requires GitHub Actions) |
 | `include_pypi_publish` | bool | `true` | Include automatic PyPI publishing (requires GitHub Actions) |
 
diff --git a/template/CHANGELOG.md.jinja b/template/CHANGELOG.md.jinja
@@ -20,6 +20,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 {%- if include_github_actions %}
 - GitHub Actions CI/CD pipelines
 {%- endif %}
-{%- if include_precommit %}
-- Pre-commit hooks for code quality
+{%- if include_prek %}
+- Prek hooks for code quality
 {%- endif %}
diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -94,13 +94,13 @@ make verify
 # Auto-fix lint and format issues
 make fix
 ```
-{%- if include_precommit %}
+{%- if include_prek %}
 
-### Pre-commit
+### Prek
 
 ```bash
-pre-commit install
-pre-commit run --all-files
+prek install
+prek run --all-files
 ```
 {%- endif %}
 {%- if include_docs %}
diff --git a/template/docs/contributing.md.jinja b/template/docs/contributing.md.jinja
@@ -16,12 +16,12 @@ Thank you for your interest in contributing to {{ project_name }}!
    ```bash
    uv sync --group dev
    ```
-{%- if include_precommit %}
+{%- if include_prek %}
 
-3. Install pre-commit hooks:
+3. Install prek hooks:
 
    ```bash
-   pre-commit install
+   prek install
    ```
 {%- endif %}
 
diff --git a/template/docs/index.md.jinja b/template/docs/index.md.jinja
@@ -73,14 +73,14 @@ uv run ruff format .
 # Type check
 uv run ty check
 ```
-{%- if include_precommit %}
+{%- if include_prek %}
 
-### Pre-commit Hooks
+### Prek Hooks
 
-Install pre-commit hooks:
+Install prek hooks:
 
 ```bash
-pre-commit install
+prek install
 ```
 {%- endif %}
 
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -47,8 +47,8 @@ dev = [
     "ruff>=0.14.14",
     "ty>=0.0.14",
     "hatch>=1.16.3",
-{%- if include_precommit %}
-    "pre-commit>=4.5.1",
+{%- if include_prek %}
+    "prek>=0.1.0",
 {%- endif %}
 ]
 {%- if include_docs %}
diff --git a/template/{% if include_prek %}.pre-commit-config.yaml{% endif %}.jinja b/template/{% if include_prek %}.pre-commit-config.yaml{% endif %}.jinja
@@ -1,5 +1,5 @@
-# Pre-commit hooks configuration
-# See https://pre-commit.com for more information
+# Prek hooks configuration
+# See https://prek.dev for more information
 
 repos:
   # General hooks
@@ -22,7 +22,7 @@ repos:
         args: [--fix]
       - id: ruff-format
 
-  # ty - Astral's type checker (local hook since no pre-commit repo yet)
+  # ty - Astral's type checker (local hook since no prek repo yet)
   - repo: local
     hooks:
       - id: ty
diff --git a/tests/test_template.py b/tests/test_template.py
@@ -27,7 +27,7 @@ def default_answers() -> dict:
         "include_github_actions": True,
         "include_docker": True,
         "include_docs": True,
-        "include_precommit": True,
+        "include_prek": True,
         "include_codecov": True,
         "include_pypi_publish": True,
         "license": "MIT",
@@ -170,17 +170,17 @@ def test_github_actions_excluded(self, tmp_path: Path, default_answers: dict):
 
         assert not file_exists(project, ".github")
 
-    def test_precommit_included(self, tmp_path: Path, default_answers: dict):
-        """Test pre-commit config is included when enabled."""
+    def test_prek_included(self, tmp_path: Path, default_answers: dict):
+        """Test prek config is included when enabled."""
         project = run_copier(tmp_path, default_answers)
 
-        precommit = project / ".pre-commit-config.yaml"
-        assert precommit.exists()
-        assert is_valid_yaml(precommit)
+        prek_config = project / ".pre-commit-config.yaml"
+        assert prek_config.exists()
+        assert is_valid_yaml(prek_config)
 
-    def test_precommit_excluded(self, tmp_path: Path, default_answers: dict):
-        """Test pre-commit config is excluded when disabled."""
-        answers = {**default_answers, "include_precommit": False}
+    def test_prek_excluded(self, tmp_path: Path, default_answers: dict):
+        """Test prek config is excluded when disabled."""
+        answers = {**default_answers, "include_prek": False}
         project = run_copier(tmp_path, answers)
 
         assert not file_exists(project, ".pre-commit-config.yaml")
