chore: add precommit script (#314)

* chore: add precommit script

* chore: add hook install to setup

* Update .githooks/pre-commit

Co-authored-by: ifropc <ifropc@apache.org>

---------

Co-authored-by: ifropc <ifropc@apache.org>

Author: zachfedor

.githooks/pre-commit

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+#
+# Pre-commit hook for Rust projects
+#
+# This hook runs cargo fmt on staged Rust files to catch formatting issues
+# before they reach CI. It's designed to be fast and non-intrusive.
+#
+# To skip this hook: git commit --no-verify
+# To skip only clippy: SKIP_CLIPPY=1 git commit
+#
+
+set -e
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Get list of staged Rust files
+STAGED_RS_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.rs$' || true)
+
+# If no Rust files are staged, exit early
+if [ -z "$STAGED_RS_FILES" ]; then
+    exit 0
+fi
+
+echo -e "${YELLOW}🔍 Checking staged Rust files...${NC}"
+
+# Run cargo fmt on the entire workspace
+# This is fast and fixes formatting issues automatically
+echo -e "${YELLOW}📝 Running cargo fmt...${NC}"
+if cargo fmt --all; then
+    # Re-stage any files that were formatted
+    for file in $STAGED_RS_FILES; do
+        if [ -f "$file" ]; then
+            git add "$file"
+        fi
+    done
+    echo -e "${GREEN}✓ Formatting complete${NC}"
+else
+    echo -e "${RED}✗ Formatting failed${NC}"
+    exit 1
+fi
+
+# Optional: Run clippy on changed files (can be slow on large projects)
+# Skip with: SKIP_CLIPPY=1 git commit
+if [ -z "$SKIP_CLIPPY" ]; then
+    echo -e "${YELLOW}🔎 Running clippy on workspace...${NC}"
+    echo -e "${YELLOW}   (Skip with: SKIP_CLIPPY=1 git commit)${NC}"
+
+    # Run clippy with --no-deps to only check workspace crates, not dependencies
+    if cargo clippy --workspace --no-deps -- -D warnings; then
+        echo -e "${GREEN}✓ Clippy checks passed${NC}"
+    else
+        echo -e "${RED}✗ Clippy found issues${NC}"
+        echo -e "${YELLOW}💡 Fix the issues above or skip with: SKIP_CLIPPY=1 git commit${NC}"
+        exit 1
+    fi
+fi
+
+echo -e "${GREEN}✓ Pre-commit checks passed!${NC}"
+exit 0

justfile

@@ -35,22 +35,23 @@ build:
 
 # Setup the project to use a pinned version of the CLI
 setup:
+    git config core.hooksPath .githooks
     -cargo binstall -y stellar-cli --version 23.1.3 --install-path ./target/bin
 
 # Build stellar-scaffold-cli test contracts to speed up testing
 build-cli-test-contracts:
     just stellar-scaffold build --manifest-path crates/stellar-scaffold-test/fixtures/soroban-init-boilerplate/Cargo.toml
 
 test: build
-    cargo nextest run -E 'package(stellar-scaffold-cli)' 
+    cargo nextest run -E 'package(stellar-scaffold-cli)'
     cargo nextest run -E 'package(stellar-registry-cli)'
     cargo nextest run
 
 test-integration: build-cli-test-contracts
     cargo nextest run --verbose --package stellar-scaffold-cli --features integration-tests --no-run
     cargo nextest run --verbose --package stellar-registry-cli --features integration-tests --no-run
     cargo nextest run --package stellar-registry-cli --features integration-tests
-    cargo nextest run --package stellar-scaffold-cli --features integration-tests 
+    cargo nextest run --package stellar-scaffold-cli --features integration-tests
 
 create: build
     rm -rf .soroban