Add pre-commit hooks

Author: codingjoe

.github/workflows/ci.yml

@@ -1,32 +1,31 @@
 name: CI
-
 on:
   push:
     branches:
       - main
   pull_request:
 jobs:
-
-  lint:
+  pre-commit:
+    if: startsWith(github.head_ref, 'dependabot/') != true
+    name: pre-commit
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        lint-command:
-          - "ruff format --check --diff ."
-          - "ruff check --output-format=github ."
+    outputs:
+      file-names: ${{ steps.diff.outputs.file-names }}
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
         with:
-          python-version: "3.x"
-          cache: 'pip'
-          cache-dependency-path: '**/pyproject.toml'
-      - run: python -m pip install -e .[lint]
-      - run: ${{ matrix.lint-command }}
-
+          fetch-depth: 0
+      - run: echo "file-names=$(git diff --name-only ${{ github.event.pull_request.base.sha }} HEAD | grep '\.py$' | tr '\n' ' ' || true)" >> "$GITHUB_OUTPUT"
+        id: diff
+      - uses: astral-sh/setup-uv@v7
+      - uses: actions/cache@v5
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+      - run: SKIP=$(yq '.ci.skip' -o csv .pre-commit-config.yaml) uvx pre-commit run --all-files --show-diff-on-failure
   dist:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [pre-commit]
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
@@ -37,11 +36,9 @@ jobs:
       - run: python -m pip install --upgrade pip build twine
       - run: python -m build --sdist --wheel
       - run: python -m twine check dist/*
-
-
   docs:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [pre-commit]
     steps:
       - uses: actions/checkout@v6
       - name: setup Python
@@ -52,10 +49,9 @@ jobs:
           cache-dependency-path: '**/pyproject.toml'
       - run: python -m pip install -e .[docs]
       - run: python -m sphinx -b html -W docs docs/_build
-
   PyTest:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [pre-commit]
     strategy:
       matrix:
         python-version:

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-ast
+      - id: check-toml
+      - id: check-yaml
+      - id: check-symlinks
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+        args: [--branch, main]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.29.1
+    hooks:
+      - id: django-upgrade
+  - repo: https://github.com/hukkin/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-ruff
+          - mdformat-footnote
+          - mdformat-gfm
+          - mdformat-gfm-alerts
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.9
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.20.0
+    hooks:
+      - id: yamlfmt
+ci:
+  autoupdate_schedule: weekly
+  skip:
+    - no-commit-to-branch