Git - prepare-commit-msg hook

prepare-commit-msg

#!/usr/bin/env sh
# . "$(dirname -- "$0")/_/husky.sh"  # - uncomment if using husky

# Get the current commit message file
COMMIT_MSG_FILE=$1
SOURCE_MSG=$2

# Ref: https://git-scm.com/docs/githooks#_prepare_commit_msg
# SOURCE_MSG is the source where the commit messsage is taken from
# - EMPTY    -> No source commit message present `git commit -a`
# - message  -> If the -m or -F flags were using when creating the commit
# - template -> If the -t flag or commit.template config was used
# - squash   -> If .git/SQUASH_MSG exists
# - commit   -> If an existing commit with -c or -C or --amend was used
if ! [ -z "$SOURCE_MSG" ]; then
    # If no existing message, then show the template
    return;
fi

commit_template="\
# Remember the git commit guidelines:
# 1. Separate subject from body with a blank line
# 2. Limit subject line to 50 characters -----> #
# 3. Capitalize the subject line
# 4. Do not end the subject line with a period
# 5. Use the imperative mood in the subject line
# 6. Wrap the body at 72 characters --------------------------------> #
# 7. Use the body to explain what and why vs. how

$(cat $COMMIT_MSG_FILE)
"

printf "$commit_template" > $COMMIT_MSG_FILE