Skip to content

Avoid Chinese messages #197

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

Avoid Chinese messages #197

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
208ea8e
Alert if the commit message is written in Chinese
jserv Feb 21, 2025
a1da15f
Remove quoted text for spell checking
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
32 changes: 32 additions & 0 deletions scripts/aspell-pws
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,3 +300,35 @@ sed
changeid
en
msg
cjk
massif
csapp
cmu
ele
lima
github
ih
it
AddressSanitizer
asan
dbg
dev
dpkg
apt
siglongjmp
sigsetjmp
SIGABRT
SIGALRM
SIGBUS
SIGFPE
SIGHUP
SIGILL
SIGINT
SIGKILL
SIGPIPE
SIGQUIT
SIGSEGV
SIGTERM
SIGTRAP
SIGUSR
SIGWINCH
16 changes: 13 additions & 3 deletions scripts/commit-msg.hook
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ validate_commit_message() {
add_warning 1 "Avoid mentioning C source filenames in the commit subject"
fi

# 11a. Disallow parentheses in the commit subject.
# 7b. Disallow parentheses in the commit subject.
if [[ ${COMMIT_SUBJECT_TO_PROCESS} =~ [\(\)] ]]; then
add_warning 1 "Avoid using parentheses '()' in commit subjects"
fi
Expand Down Expand Up @@ -334,8 +334,18 @@ validate_commit_message() {
# 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)
# Alert if the commit message appears to be written in Chinese.
# This pattern matches any Chinese character (common CJK Unified Ideographs).
MISSPELLED_WORDS=$(echo "$FULL_COMMIT_MSG" | grep "[一-龥]")
if [ -n "$MISSPELLED_WORDS" ]; then
add_warning 1 "Commit message appears to be written in Chinese: $MISSPELLED_WORDS"
fi

# Remove quoted text from FULL_COMMIT_MSG for spell checking.
MSG_FOR_SPELLCHECK=$(echo "$FULL_COMMIT_MSG" | sed -E "s/(['\"][^'\"]*['\"])//g")

# Use aspell to list misspelled words according to American English, ignoring quoted text.
MISSPELLED_WORDS=$(echo "$MSG_FOR_SPELLCHECK" | $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
Expand Down