Migrate from pre-commit to prek (#280)

* Migrate from pre-commit to prek

* Update Poetry lock file

Author: klaasnicolaas

.github/workflows/linting.yaml

@@ -36,8 +36,8 @@ jobs:
       - name: 🚀 Run ruff formatter
         run: poetry run ruff format --check .
 
-  pre-commit-hooks:
-    name: pre-commit-hooks
+  prek-hooks:
+    name: prek-hooks
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
@@ -57,31 +57,31 @@ jobs:
       - name: 🏗 Install Python dependencies
         run: poetry install --no-interaction
       - name: 🚀 Check Python AST
-        run: poetry run pre-commit run check-ast --all-files
+        run: poetry run prek run check-ast --all-files
       - name: 🚀 Check for case conflicts
-        run: poetry run pre-commit run check-case-conflict --all-files
+        run: poetry run prek run check-case-conflict --all-files
       - name: 🚀 Check docstring is first
-        run: poetry run pre-commit run check-docstring-first --all-files
+        run: poetry run prek run check-docstring-first --all-files
       - name: 🚀 Check that executables have shebangs
-        run: poetry run pre-commit run check-executables-have-shebangs --all-files
+        run: poetry run prek run check-executables-have-shebangs --all-files
       - name: 🚀 Check JSON files
-        run: poetry run pre-commit run check-json --all-files
+        run: poetry run prek run check-json --all-files
       - name: 🚀 Check for merge conflicts
-        run: poetry run pre-commit run check-merge-conflict --all-files
+        run: poetry run prek run check-merge-conflict --all-files
       - name: 🚀 Check for broken symlinks
-        run: poetry run pre-commit run check-symlinks --all-files
+        run: poetry run prek run check-symlinks --all-files
       - name: 🚀 Check TOML files
-        run: poetry run pre-commit run check-toml --all-files
+        run: poetry run prek run check-toml --all-files
       - name: 🚀 Check XML files
-        run: poetry run pre-commit run check-xml --all-files
+        run: poetry run prek run check-xml --all-files
       - name: 🚀 Check YAML files
-        run: poetry run pre-commit run check-yaml --all-files
+        run: poetry run prek run check-yaml --all-files
       - name: 🚀 Detect Private Keys
-        run: poetry run pre-commit run detect-private-key --all-files
+        run: poetry run prek run detect-private-key --all-files
       - name: 🚀 Check End of Files
-        run: poetry run pre-commit run end-of-file-fixer --all-files
+        run: poetry run prek run end-of-file-fixer --all-files
       - name: 🚀 Trim Trailing Whitespace
-        run: poetry run pre-commit run trailing-whitespace --all-files
+        run: poetry run prek run trailing-whitespace --all-files
 
   yamllint:
     name: yamllint

.pre-commit-config.yaml

@@ -8,14 +8,14 @@ repos:
         types: [python]
         entry: poetry run ruff check --fix
         require_serial: true
-        stages: [pre-commit, pre-push, manual]
+        stages: [commit, push, manual]
       - id: ruff-format
         name: 🐶 Ruff Formatter
         language: system
         types: [python]
         entry: poetry run ruff format
         require_serial: true
-        stages: [pre-commit, pre-push, manual]
+        stages: [commit, push, manual]
       - id: check-ast
         name: 🐍 Check Python AST
         language: system
@@ -35,7 +35,7 @@ repos:
         language: system
         types: [text, executable]
         entry: poetry run check-executables-have-shebangs
-        stages: [pre-commit, pre-push, manual]
+        stages: [commit, push, manual]
       - id: check-json
         name: ｛ Check JSON files
         language: system
@@ -76,7 +76,7 @@ repos:
         language: system
         types: [text]
         entry: poetry run end-of-file-fixer
-        stages: [pre-commit, pre-push, manual]
+        stages: [commit, push, manual]
       - id: no-commit-to-branch
         name: 🛑 Don't commit to main branch
         language: system
@@ -102,7 +102,7 @@ repos:
         language: system
         types: [text]
         entry: poetry run trailing-whitespace-fixer
-        stages: [pre-commit, pre-push, manual]
+        stages: [commit, push, manual]
       - id: yamllint
         name: 🎗 Check YAML files with yamllint
         language: system

README.md

@@ -136,19 +136,19 @@ poetry install
 _Poetry creates by default an virtual environment where it installs all
 necessary pip packages_.
 
-### Pre-commit
+### Prek
 
-This repository uses the [pre-commit][pre-commit] framework, all changes
-are linted and tested with each commit. To setup the pre-commit check, run:
+This repository uses the [prek][prek] framework, all changes
+are linted and tested with each commit. To setup the prek check, run:
 
 ```bash
-poetry run pre-commit install
+poetry run prek install
 ```
 
 And to run all checks and tests manually, use the following command:
 
 ```bash
-poetry run pre-commit run --all-files
+poetry run prek run --all-files
 ```
 
 ### Testing
@@ -210,4 +210,4 @@ SOFTWARE.
 
 [poetry-install]: https://python-poetry.org/docs/#installation
 [poetry]: https://python-poetry.org
-[pre-commit]: https://pre-commit.com
+[prek]: https://github.com/j178/prek