Skip to content

docs(readme): update husky instruction to run commitizen on git commit #982

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 3 commits into
base: master
Choose a base branch
from
Open

docs(readme): update husky instruction to run commitizen on git commit #982

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d414cb7
docs(readme): update husky instruction to run commitizen on git commit
FreePhoenix888 Sep 4, 2023
47bbff7
Update README.md
FreePhoenix888 Sep 7, 2023
2abb06b
Update README.md
FreePhoenix888 Sep 12, 2023
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
36 changes: 29 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,14 +156,36 @@ exec < /dev/tty && node_modules/.bin/cz --hook || true

##### Husky

For `husky` users, add the following configuration to the project's `package.json` file:
For `husky` users, add the following configuration to the `.husky/prepare-commit-msg` file:

```json
"husky": {
"hooks": {
"prepare-commit-msg": "exec < /dev/tty && npx cz --hook || true"
}
}
```sh
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

# Ignore if amend commit
parent=$(/bin/ps -o ppid -p $PPID | tail -1)
if [ -n "$parent" ]; then
amended=$(/bin/ps -o command -p $parent | grep -e '--amend')
if [ -n "$amended" ]; then
exit 0
fi
fi

# Check if COMMIT_EDITMSG is just a default message
if grep -q "# Please enter the commit message" ".git/COMMIT_EDITMSG"; then
# Remove the default message
echo "" > .git/COMMIT_EDITMSG
# Run commitizen
exec < /dev/tty && npx cz --hook || true
else
# Use the provided commit message
exit 0
fi
```

And make this file executable
```sh
.husky/prepare-commit-msg
```

> **Why `exec < /dev/tty`?** By default, git hooks are not interactive. This command allows the user to use their terminal to interact with Commitizen during the hook.
Expand Down