formal: check for more guideline violations

Check if first word after prefix is capitalized.
Check if subject ends with a period.
Check subject line and body line lengths and colorize the excess.

Signed-off-by: George Sapkin <[email protected]>

Author: GeorgeSapkin

.github/scripts/check_formalities.sh

@@ -1,5 +1,9 @@
 #!/bin/bash
 
+# Based on https://openwrt.org/submitting-patches#submission_guidelines
+MAX_SUBJECT_LEN=50
+MAX_BODY_LINE_LEN=75
+
 source workflow_context/.github/scripts/ci_helpers.sh
 
 RET=0
@@ -48,19 +52,63 @@ for commit in $(git rev-list HEAD ^origin/"$BRANCH"); do
 		RET=1
 	fi
 
+	echo
+	info "Checking subject:"
 	subject="$(git show -s --format=%s "$commit")"
-	if echo "$subject" | grep -q -e '^[0-9A-Za-z,+/_-]\+: ' -e '^Revert '; then
-		success "Commit subject line seems OK ($subject)"
-	elif echo "$subject" | grep -iq '^Translated using Weblate.*'; then
-		warn "Weblate commit subject line exception: $subject"
-	elif echo "$subject" | grep -iq '^Added translation using Weblate.*'; then
-		warn "Weblate commit subject line exception: $subject"
+	echo "$subject"
+
+	# Check subject format
+	if echo "$subject" | grep -iq -e '^Translated using Weblate.*' -e '^Added translation using Weblate.*'; then
+		warn "Weblate commit subject line exception"
+	elif echo "$subject" | grep -q -e '^[0-9A-Za-z,+/_-]\+: [a-z]' -e '^Revert '; then
+		success "Commit subject line format seems OK"
+	elif echo "$subject" | grep -q -e '^[0-9A-Za-z,+/_-]\+: [A-Z]'; then
+		err "First word after prefix in subject should not be capitalized"
+		RET=1
+	elif echo "$subject" | grep -q -e '^[0-9A-Za-z,+/_-]\+: '; then
+		# Handles cases when there's a prefix but the check for capitalization fails (e.g. no word
+		# after prefix)
+		err "Commit subject line MUST start with '<package name>: ' and be followed by a lower-case word"
+		RET=1
 	else
-		err "Commit subject line MUST start with '<package name>: ' ($subject)"
+		err "Commit subject line MUST start with '<package name>: '"
+		RET=1
+	fi
+
+	if echo "$subject" | grep -q '\.$'; then
+		err "Commit subject line should not end with a period"
 		RET=1
 	fi
 
+	# Check subject length
+	if [ ${#subject} -gt "$MAX_SUBJECT_LEN" ]; then
+		warn "Commit subject line is longer that $MAX_SUBJECT_LEN characters (is ${#subject})"
+		split_err "$MAX_SUBJECT_LEN" "$subject"
+	else
+		success "Commit subject line is $MAX_SUBJECT_LEN characters or less"
+	fi
+
+	echo
+	info "Checking body:"
 	body="$(git show -s --format=%b "$commit")"
+	echo "$body"
+	echo
+
+	# Check body line lengths
+	body_line_too_long=0
+	line_num=0
+	while IFS= read -r line; do
+		line_num=$((line_num + 1))
+		if [ ${#line} -gt "$MAX_BODY_LINE_LEN" ]; then
+			warn "Commit body line $line_num is longer than $MAX_BODY_LINE_LEN characters (is ${#line}):"
+			split_err "$MAX_BODY_LINE_LEN" "$line"
+			body_line_too_long=1
+		fi
+	done <<< "$body"
+	if [ "$body_line_too_long" = 0 ]; then
+		success "Commit body lines are $MAX_BODY_LINE_LEN characters or less"
+	fi
+
 	sob="$(git show -s --format='Signed-off-by: %aN <%aE>' "$commit")"
 	if echo "$body" | grep -qF "$sob"; then
 		success "Signed-off-by matches author"
@@ -78,12 +126,15 @@ for commit in $(git rev-list HEAD ^origin/"$BRANCH"); do
 		success "Signed-off-by email is not a GitHub noreply email"
 	fi
 
-	if echo "$body" | grep -v "Signed-off-by:"; then
+	if echo "$body" | grep -qv "Signed-off-by:"; then
 		success "A commit message exists"
 	else
 		err "Commit message is missing. Please describe your changes."
 		RET=1
 	fi
+
+	info "=== Done checking commit '$commit'"
+	echo
 done
 
 exit $RET

.github/scripts/ci_helpers.sh

@@ -20,6 +20,11 @@ warn() {
 	color_out 33 "$1"
 }
 
+# Prints the string and colors the part after the given length in red
+split_err() {
+	printf "%s\e[0;31m%s\e[0;0m\n" "${2:0:$1}" "${2:$1}"
+}
+
 err_die() {
 	err "$1"
 	exit 1