ci: automate code formatting and linting with git hooks

Author: ns-vasilev

.github/workflows/ci.yml

@@ -23,16 +23,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  SwiftLint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v5
-      - name: GitHub Action for SwiftLint
-        uses: norio-nomura/action-swiftlint@3.2.1
-        with:
-          args: --strict
-        env:
-          DIFF_BASE: ${{ github.base_ref }}
   macOS:
     name: ${{ matrix.name }}
     runs-on: ${{ matrix.runsOn }}
@@ -205,23 +195,3 @@ jobs:
         with:
           name: MergedResult
           path: test_output/final
-
-  discover-typos:
-    name: Discover Typos
-    runs-on: macos-15
-    env:
-      DEVELOPER_DIR: /Applications/Xcode_16.4.app/Contents/Developer
-    steps:
-      - uses: actions/checkout@v5
-
-      - name: Set up Python environment
-        run: |
-          python3 -m venv .venv
-          source .venv/bin/activate
-          pip install --upgrade pip
-          pip install codespell
-
-      - name: Discover typos
-        run: |
-          source .venv/bin/activate
-          codespell --ignore-words-list="hart,inout,msdos,sur" --skip="./.build/*,./.git/*"

.github/workflows/lint.yml

@@ -0,0 +1,45 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - "Sources/**"
+      - ".github/workflows/ci.yml"
+      - "Tests/**"
+
+concurrency:
+  group: lint-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v5
+      - uses: jdx/mise-action@v3
+      - name: Run
+        run: mise run lint
+
+  discover-typos:
+    name: discover-typos
+    runs-on: macos-15
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_16.4.app/Contents/Developer
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python environment
+        run: |
+          python3 -m venv .venv
+          source .venv/bin/activate
+          pip install --upgrade pip
+          pip install codespell
+
+      - name: Discover typos
+        run: |
+          source .venv/bin/activate
+          codespell --ignore-words-list="hart,inout,msdos,sur" --skip="./.build/*,./.git/*"

Makefile

@@ -259,7 +259,7 @@ dependencies: [
 Bootstrapping development environment
 
 ```
-make bootstrap
+mise install
 ```
 
 Please feel free to help out with this project! If you see something that could be made better or want a new feature, open up an issue or send a Pull Request!

Mintfile

@@ -1,8 +1,10 @@
 [tools]
 git-cliff = "2.9.1"
-
-[hooks]
-postinstall = "mise run install"
+swiftlint = "0.62.2"
+swiftformat = "0.58.6"
 
 [settings]
-experimental = true
+experimental = true
+
+[hooks]
+postinstall = "mise run install"

README.md

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+set -e
+
+echo "🔧 Installing git hooks..."
+
+# Find git repository root
+GIT_ROOT=$(git rev-parse --show-toplevel 2>/dev/null)
+
+if [ -z "$GIT_ROOT" ]; then
+    echo "❌ Error: Not a git repository"
+    exit 1
+fi
+
+echo "📁 Git root: $GIT_ROOT"
+
+# Create hooks directory if it doesn't exist
+mkdir -p "$GIT_ROOT/.git/hooks"
+
+# Create pre-commit hook
+cat > "$GIT_ROOT/.git/hooks/pre-commit" <<'HOOK_EOF'
+#!/bin/bash
+
+echo "🔍 Running linters..."
+
+echo "📝 Formatting staged Swift files..."
+git diff --diff-filter=d --staged --name-only | grep -e '\.swift$' | while read line; do
+  if [[ $line == *"/Generated"* ]]; then
+    echo "⏭️  Skipping generated file: $line"
+  else
+    echo "✨ Formatting: $line"
+    mise exec swiftformat -- swiftformat "${line}"
+    git add "$line"
+  fi
+done
+
+if ! mise run lint; then
+    echo "❌ Lint failed. Please fix the issues before committing."
+    echo "💡 Tip: Run 'mise run format' to auto-fix some issues"
+    echo "⚠️  To skip this hook, use: git commit --no-verify"
+    exit 1
+fi
+
+echo "✅ All checks passed!"
+exit 0
+HOOK_EOF
+
+chmod +x "$GIT_ROOT/.git/hooks/pre-commit"
+
+echo "✅ Git hooks installed successfully!"
+echo "📍 Hook location: $GIT_ROOT/.git/hooks/pre-commit"
+echo ""
+echo "Pre-commit hook will:"
+echo "  1. Format staged Swift files (except /Generated)"
+echo "  2. Run mise lint"
+echo ""
+echo "To skip the hook, use: git commit --no-verify"

hooks/pre-commit

@@ -0,0 +1,13 @@
+#!/bin/bash
+#MISE description="Lint the validator package using SwiftLint and SwiftFormat"
+#MISE usage flag "-f --fix" help="Fix the fixable issues"
+
+set -eo pipefail
+
+if [ "$usage_fix" = "true" ]; then
+  swiftformat Sources
+  swiftlint lint --fix --quiet --config .swiftlint.yml Sources
+else
+  swiftformat Sources --lint
+  swiftlint lint --quiet --config .swiftlint.yml Sources
+fi