Merge branch 'main' into ci/audit-and-deny

Author: Danielobito009

.githooks/pre-commit

@@ -1,52 +1,94 @@
 #!/usr/bin/env bash
-# Git pre-commit hook: runs cargo fmt --check and cargo clippy on staged Rust files.
+# .githooks/pre-commit
 #
-# Security & Quality Controls:
-# - Strict mode: set -euo pipefail
-# - Runs fmt check and clippy (-D warnings) against staged files
-# - Bypassing is permitted via standard `git commit --no-verify` (Git native flag) or SKIP_PRE_COMMIT=1
+# Runs `cargo fmt --check` and `cargo clippy --all-targets -- -D warnings`
+# against the workspace whenever Rust source files are staged.
+#
+# Install once with:
+#   ./scripts/install_git_hooks.sh
+#
+# Bypass options (in order of preference):
+#   git commit --no-verify          # standard Git flag, no logging
+#   SKIP_PRE_COMMIT=1 git commit    # env-variable bypass, warning is logged
+#
+# The env-variable bypass exists for automated tooling (e.g. release scripts)
+# that need to commit without running the full check suite. It intentionally
+# prints a warning to stderr so the bypass is visible in CI logs.
+#
+# Clippy config drift: the hook honours clippy.toml / .clippy.toml when
+# present, and the workspace-level [lints.clippy] table in Cargo.toml.
+# Any lint configuration change is therefore automatically picked up on
+# the next commit — no hook update required.
 
 set -euo pipefail
 
-echo "==> Running pre-commit hooks..."
-
-# Check if hook bypass environment variable is explicitly set
-if [ "${SKIP_PRE_COMMIT:-0}" = "1" ] || [ "${NO_VERIFY:-0}" = "1" ]; then
-    echo "[pre-commit] WARNING: Pre-commit checks bypassed via environment variable."
+# ── Bypass: SKIP_PRE_COMMIT env-var ─────────────────────────────────────────
+if [ "${SKIP_PRE_COMMIT:-0}" = "1" ]; then
+    echo "[pre-commit] WARNING: checks bypassed via SKIP_PRE_COMMIT=1." >&2
     exit 0
 fi
 
-# Retrieve staged .rs files (Added, Copied, Modified, Renamed)
-STAGED_RS_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep '\.rs$' || true)
+# ── Detect staged Rust files ─────────────────────────────────────────────────
+# diff-filter ACMR: Added, Copied, Modified, Renamed — excludes Deleted (D)
+# so we never try to check files that no longer exist on disk.
+STAGED_RS=$(git diff --cached --name-only --diff-filter=ACMR | grep '\.rs$' || true)
 
-if [ -z "$STAGED_RS_FILES" ]; then
-    echo "[pre-commit] No staged Rust files detected. Skipping fmt and clippy checks."
+if [ -z "$STAGED_RS" ]; then
+    # No Rust files staged — nothing to check.
     exit 0
 fi
 
-echo "[pre-commit] Staged Rust files detected:"
-echo "$STAGED_RS_FILES" | sed 's/^/  - /'
+echo "[pre-commit] Staged Rust files:"
+echo "$STAGED_RS" | sed 's/^/  /'
 
-# Read staged files into array safely
-mapfile -t FILES_ARRAY <<< "$STAGED_RS_FILES"
+# Resolve the repo root so cargo commands work regardless of where the user
+# ran `git commit` from (e.g. a subdirectory).
+REPO_ROOT=$(git rev-parse --show-toplevel)
 
-# 1. Run cargo fmt --check against staged files
-echo "[pre-commit] Running cargo fmt check..."
-if ! cargo fmt --check -- "${FILES_ARRAY[@]}"; then
+# ── 1. cargo fmt --check ─────────────────────────────────────────────────────
+# Passes the list of staged files so only those files are checked. This is
+# faster than a full workspace fmt and avoids failing on pre-existing
+# formatting issues in files the commit does not touch.
+echo "[pre-commit] cargo fmt --check ..."
+
+# Build the file list as an array to handle paths with spaces safely.
+mapfile -t STAGED_ARRAY <<< "$STAGED_RS"
+# Prefix each path with the repo root so paths are absolute.
+ABS_FILES=()
+for f in "${STAGED_ARRAY[@]}"; do
+    ABS_FILES+=("$REPO_ROOT/$f")
+done
+
+if ! cargo fmt --manifest-path "$REPO_ROOT/Cargo.toml" --check -- "${ABS_FILES[@]}" 2>&1; then
     echo ""
-    echo "❌ Error: Code formatting check failed on staged files."
-    echo "💡 Fix by running: cargo fmt"
+    echo "[pre-commit] ❌ Formatting check failed." >&2
+    echo "[pre-commit]    Run \`cargo fmt\` to fix, then re-stage and commit." >&2
+    echo "[pre-commit]    To bypass (not recommended): git commit --no-verify" >&2
     exit 1
 fi
+echo "[pre-commit] ✅ fmt OK"
+
+# ── 2. cargo clippy --all-targets ────────────────────────────────────────────
+# We run clippy across all targets (lib, tests, benches, examples) rather than
+# only the staged files because:
+#   a) Clippy cannot accept individual file paths — it works at crate granularity.
+#   b) A change in one file can introduce a lint in a test that imports it.
+#
+# -D warnings turns all warnings into errors, matching the CI gate.
+# The workspace [lints.clippy] table and any clippy.toml are honoured automatically.
+echo "[pre-commit] cargo clippy --all-targets -- -D warnings ..."
 
-# 2. Run cargo clippy against staged targets / workspace
-echo "[pre-commit] Running cargo clippy..."
-if ! cargo clippy --all-targets -- -D warnings; then
+if ! cargo clippy \
+    --manifest-path "$REPO_ROOT/Cargo.toml" \
+    --all-targets \
+    -- -D warnings 2>&1; then
     echo ""
-    echo "❌ Error: Cargo clippy found compiler warnings or errors."
-    echo "💡 Fix the clippy issues before committing."
+    echo "[pre-commit] ❌ Clippy check failed." >&2
+    echo "[pre-commit]    Fix the warnings above, re-stage, and commit." >&2
+    echo "[pre-commit]    To bypass (not recommended): git commit --no-verify" >&2
     exit 1
 fi
+echo "[pre-commit] ✅ clippy OK"
 
-echo "✅ Pre-commit checks passed successfully!"
+echo "[pre-commit] All checks passed."
 exit 0

README.md

@@ -142,12 +142,43 @@ This produces the WASM under `target/` for deployment to Stellar (e.g. testnet/m
 
 ### 6. Install Git hooks
 
-Set up the repository pre-commit hook to enforce code formatting (`cargo fmt`) and linting (`cargo clippy`) on staged files prior to committing:
+Set up the repository pre-commit hook to enforce code formatting and linting
+on staged files before every commit:
 
 ```bash
 ./scripts/install_git_hooks.sh
 ```
 
+The installer is **idempotent** — safe to run repeatedly. It:
+
+1. Sets the executable bit on all scripts under `.githooks/`.
+2. Runs `git config core.hooksPath .githooks` (no global config changes).
+3. Smoke-tests the hook to confirm it exits 0.
+
+After installation, every `git commit` automatically runs:
+
+| Check | Command | Scope |
+|-------|---------|-------|
+| Formatting | `cargo fmt --check` | staged `.rs` files only |
+| Linting | `cargo clippy --all-targets -- -D warnings` | full workspace |
+
+**Bypass options:**
+
+```bash
+git commit --no-verify              # standard Git flag, no logging
+SKIP_PRE_COMMIT=1 git commit        # env-var bypass, prints a warning to stderr
+```
+
+**Verify the installation is correct without modifying anything:**
+
+```bash
+./scripts/install_git_hooks.sh --check
+```
+
+> Note: `cargo clippy` always runs against the full workspace (not only staged files)
+> because clippy operates at crate granularity. A change in one file can surface
+> a lint in a test that imports it, so the broader scope is intentional.
+
 ---
 
 ## Build, test, and deploy
@@ -158,6 +189,7 @@ Set up the repository pre-commit hook to enforce code formatting (`cargo fmt`) a
 | Run tests | `cargo test` |
 | Build contract WASM | `soroban contract build` |
 | Install Git hooks | `./scripts/install_git_hooks.sh` |
+| Verify hook installation | `./scripts/install_git_hooks.sh --check` |
 | One-command local deploy | `./scripts/deploy_local.sh` |
 | Run with Soroban CLI (e.g. testnet) | See [Stellar docs](https://developers.stellar.org/docs/tools/soroban-cli) for `soroban contract deploy` and `invoke`. |