Skip to content

📝 forge fmt and forge snapshot pre-commit hook #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📝 forge fmt and forge snapshot pre-commit hook #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,11 @@ forge test
```sh
forge snapshot
```

### Pre-commit Hook

We recommend installing the accompanying pre-commit hook to automatically run `forge fmt` and `forge snapshot` on each commit:

```bash
cp hooks/pre-commit .git/hooks/pre-commit
```
24 changes: 24 additions & 0 deletions hooks/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/bin/bash

BWHITE='\033[1;37m'
RED='\033[0;31m'
GREEN='\033[0;32m'
NC='\033[0m'

printf "Running ${BWHITE}forge fmt${NC}... \n"
if forge fmt &>/dev/null; then
printf "${GREEN}Formatted!${NC} \n"
else
printf "${RED}error running ${BWHITE}forge fmt${NC} \n"
exit 1
fi

printf "Running ${BWHITE}forge snapshot${NC}... \n"
if forge snapshot &>/dev/null; then
printf "${GREEN}Snapshotted!${NC} \n"
else
printf "${RED}error running ${BWHITE}forge snapshot${NC} \n"
exit 1
fi

git add .