|
| 1 | +# Git Hooks |
| 2 | + |
| 3 | +This project uses Git hooks to maintain code quality and prevent CI failures. |
| 4 | + |
| 5 | +## Pre-commit Hook |
| 6 | + |
| 7 | +The pre-commit hook automatically runs before each commit to validate: |
| 8 | + |
| 9 | +### ✅ **Rust Validation** |
| 10 | +- Formats Rust code with `cargo fmt` |
| 11 | +- Runs `cargo clippy --workspace -- -D warnings` to catch linting issues |
| 12 | +- Runs `cargo check --workspace` to verify compilation |
| 13 | +- Automatically adds formatted files to the commit |
| 14 | + |
| 15 | +### ✅ **TypeScript Validation** |
| 16 | +- Runs `pnpm lint` to check code style and catch common errors |
| 17 | +- Runs `pnpm typecheck` to verify type correctness |
| 18 | +- Checks all TypeScript files in the workspace |
| 19 | + |
| 20 | +## Setup |
| 21 | + |
| 22 | +The hook is automatically set up when you: |
| 23 | +1. Clone the repository |
| 24 | +2. Run `pnpm install` (triggers `prepare` script) |
| 25 | + |
| 26 | +### Manual Setup |
| 27 | + |
| 28 | +If the hook isn't working, run: |
| 29 | + |
| 30 | +```bash |
| 31 | +# Make hook executable (Linux/Mac) |
| 32 | +chmod +x .git/hooks/pre-commit |
| 33 | + |
| 34 | +# Windows (PowerShell) |
| 35 | +icacls ".git\hooks\pre-commit" /grant Everyone:RX |
| 36 | +``` |
| 37 | + |
| 38 | +## Testing the Hook |
| 39 | + |
| 40 | +To test the validation without committing: |
| 41 | + |
| 42 | +```bash |
| 43 | +# Run both checks |
| 44 | +pnpm validate |
| 45 | + |
| 46 | +# Or individually |
| 47 | +cargo clippy --workspace -- -D warnings |
| 48 | +cargo check --workspace |
| 49 | +pnpm lint |
| 50 | +pnpm typecheck |
| 51 | +``` |
| 52 | + |
| 53 | +## Bypassing the Hook (Not Recommended) |
| 54 | + |
| 55 | +In rare cases where you need to bypass validation: |
| 56 | + |
| 57 | +```bash |
| 58 | +git commit --no-verify -m "your message" |
| 59 | +``` |
| 60 | + |
| 61 | +**Note**: Only use `--no-verify` when absolutely necessary, as it skips important validations that prevent CI failures. |
| 62 | + |
| 63 | +## Troubleshooting |
| 64 | + |
| 65 | +### Hook not running |
| 66 | +- Ensure `.git/hooks/pre-commit` exists |
| 67 | +- Check it's executable: `ls -la .git/hooks/pre-commit` |
| 68 | +- Try manual setup commands above |
| 69 | + |
| 70 | +### Hook fails on Windows |
| 71 | +- The hook uses bash scripting (requires Git Bash or WSL) |
| 72 | +- Alternatively, use the PowerShell version: `.git/hooks/pre-commit.ps1` |
| 73 | +- Configure Git to use PowerShell hooks: |
| 74 | + ```powershell |
| 75 | + git config core.hooksPath .git/hooks |
| 76 | + ``` |
| 77 | + |
| 78 | +### Slow validation |
| 79 | +- The hook only validates files in your commit (staged changes) |
| 80 | +- If you have many Rust crates, consider using `cargo check -p <crate-name>` |
| 81 | +- TypeScript check runs on entire workspace (necessary for type consistency) |
| 82 | + |
| 83 | +## CI Integration |
| 84 | + |
| 85 | +These same checks run in CI: |
| 86 | +- GitHub Actions runs `cargo check` and `pnpm typecheck` |
| 87 | +- Pre-commit hooks help catch issues early before pushing |
0 commit comments