Skip to content

Enforce english commit #196

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

Merged
merged 2 commits into from
Feb 21, 2025
Merged

Enforce english commit #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3d4a0b
Enforce American English in commit messages
jserv Feb 21, 2025
bb2d2be
Filter out hyperlinks
jserv Feb 21, 2025
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
2 changes: 2 additions & 0 deletions scripts/aspell-pws
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,3 +298,5 @@ tcp
awk
sed
changeid
en
msg
12 changes: 11 additions & 1 deletion scripts/commit-msg.hook
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,13 +322,23 @@ validate_commit_message() {
# 12. Avoid abusive language in commit message content
# ------------------------------------------------------------------------------

FULL_COMMIT_MSG=$(sed '/^#/d;/^[[:space:]]*$/d' "$COMMIT_MSG_FILE")
FULL_COMMIT_MSG=$(sed '/^#/d;/^[[:space:]]*$/d;/^[[:space:]]*Change-Id:/d' "$COMMIT_MSG_FILE" | \
sed -E "s@${URL_REGEX#^}@@g")
# Extended list of abusive words (case-insensitive).
# Adjust the list as needed.
ABUSIVE_WORDS_REGEX='\b(fuck|fucking|dick|shit|bitch|asshole|cunt|motherfucker|damn|crap|dumbass|piss)\b'
if echo "$FULL_COMMIT_MSG" | grep -Eiq "$ABUSIVE_WORDS_REGEX"; then
add_warning 1 "Commit message contains inappropriate language. Avoid using abusive words"
fi

# 13. Always use American English.
# ------------------------------------------------------------------------------

# Use aspell to list misspelled words according to American English.
MISSPELLED_WORDS=$(echo "$FULL_COMMIT_MSG" | $ASPELL --lang=en --list --home-dir=scripts --personal=aspell-pws)
if [ -n "$MISSPELLED_WORDS" ]; then
add_warning 1 "Avoid using non-American English words"
fi
}

unset GREP_OPTIONS
Expand Down