[MERGE] Integrates Various Improvements (- WIP #199 -)

Impacts PRs:

  * Includes and Superceeds PR/MR #321
  * Includes and Superceeds PR/MR #322
  * Includes and Superceeds PR/MR #323
  * Includes and Superceeds PR/MR #325

Impacts GHI:

 - [x] Closes #266
 - [x] Closes #272
 - [x] Closes #151

---

Author: reactive-firewall

.github/workflows/CI-BUILD.yml

@@ -163,7 +163,7 @@ jobs:
       - id: check_status
         run: |
           if [[ "${{ needs.BUILD.result }}" == "success" && "${{ needs.BOOTSTRAP.result }}" == "success" ]]; then
-            echo "build_success=true" >> $GITHUB_OUTPUT
+            echo "build_success=true" >> "$GITHUB_OUTPUT"
           else
-            echo "build_success=false" >> $GITHUB_OUTPUT
+            echo "build_success=false" >> "$GITHUB_OUTPUT"
           fi

.github/workflows/CI-MATs.yml

@@ -43,17 +43,17 @@ jobs:
       - id: check
         run: |
           if [[ "${{ github.event.workflow_run.conclusion }}" == "success" ]]; then
-            echo "should_run=true" >> $GITHUB_OUTPUT
+            echo "should_run=true" >> "$GITHUB_OUTPUT"
           else
-            echo "should_run=false" >> $GITHUB_OUTPUT
+            echo "should_run=false" >> "$GITHUB_OUTPUT"
           fi
       - id: get_env
         run: |
           ENV_VALUE=$(gh api "${{ github.event.workflow_run.artifacts_url }}" --jq '.environment')
           if [[ -n "$ENV_VALUE" ]]; then
-            echo "environment=$ENV_VALUE" >> $GITHUB_OUTPUT
+            echo "environment=$ENV_VALUE" >> "$GITHUB_OUTPUT"
           else
-            echo "environment=Experimenting" >> $GITHUB_OUTPUT  # Default fallback
+            echo "environment=Experimenting" >> "$GITHUB_OUTPUT"  # Default fallback
           fi
 
   MATS:
@@ -121,7 +121,7 @@ jobs:
       - id: check_status
         run: |
           if [[ "${{ needs.MATS.result }}" == "success" ]]; then
-            echo "mats_success=true" >> $GITHUB_OUTPUT
+            echo "mats_success=true" >> "$GITHUB_OUTPUT"
           else
-            echo "mats_success=false" >> $GITHUB_OUTPUT
+            echo "mats_success=false" >> "$GITHUB_OUTPUT"
           fi

.github/workflows/Tests.yml

@@ -42,17 +42,17 @@ jobs:
       - id: check
         run: |
           if [[ "${{ github.event.workflow_run.conclusion }}" == "success" ]]; then
-            echo "should_run=true" >> $GITHUB_OUTPUT
+            echo "should_run=true" >> "$GITHUB_OUTPUT"
           else
-            echo "should_run=false" >> $GITHUB_OUTPUT
+            echo "should_run=false" >> "$GITHUB_OUTPUT"
           fi
       - id: get_env
         run: |
           ENV_VALUE=$(gh api "${{ github.event.workflow_run.artifacts_url }}" --jq '.environment')
           if [[ -n "$ENV_VALUE" ]]; then
-            echo "environment=$ENV_VALUE" >> $GITHUB_OUTPUT
+            echo "environment=$ENV_VALUE" >> "$GITHUB_OUTPUT"
           else
-            echo "environment=Experimenting" >> $GITHUB_OUTPUT  # Default fallback
+            echo "environment=Experimenting" >> "$GITHUB_OUTPUT"  # Default fallback
           fi
 
 

pyproject.toml

@@ -12,7 +12,7 @@ extend-select = ["D", "E"]
 # Ignore specific warnings and errors according to CEP-7 style
 extend-ignore = ["E117", "D203", "D208", "D212"]
 # REQUIRED CEP-7 Custom Exceptions:
-#    E117,  # Over-indented - RECCOMENDED
+#    E117,  # Over-indented - RECOMMENDED
 #    D208,  # Docstring is over-indented - CEP-7
 #    D203,  # 1 blank line required before class docstring - CEP-7
 #    D212,  # Multi-line docstring summary should start at the first line - CEP-7

tests/check_spelling

@@ -127,6 +127,7 @@ check_command grep ;
 check_command python3 ;
 test -x "$(command -v codespell)" || exit 0 ;  # skip quietly if user has not installed GPL2 stuff.
 check_command git ;
+check_command sed ;
 check_command shlock ;
 
 
@@ -135,9 +136,15 @@ SCRIPT_FILE="tests/check_spelling"
 # Set codespell options
 CODESPELL_OPTIONS="--quiet-level=4 --builtin clear,rare,code -L assertIn"
 
+# Define specific typos to check for (regression tests)
+declare -a SPECIFIC_TYPOS=(
+	"RECCOMENDED:RECOMMENDED"
+)
+
 function cleanup() {
 	rm -f "${LOCK_FILE}" 2>/dev/null || : ; wait ;
 	# unset when done
+	unset SPECIFIC_TYPOS 2>/dev/null || : ;
 	unset LOCK_FILE 2>/dev/null || : ;
 	hash -d shlock 2>/dev/null || : ;
 }
@@ -195,11 +202,35 @@ if [[ "$1" == "--fix" ]]; then
 fi
 
 # THIS IS THE ACTUAL TEST
-# Iterate over files and run codespell
+# Iterate over files
 # shellcheck disable=SC2086
 for FILE in $FILES_TO_CHECK; do
+	# Part 1: Run codespell
 	printf "::group::%s\n" "Checking ${FILE}" ;
+	printf "::debug::%s\n" "Running codespell tests for typos." ;
 	{ codespell $CODESPELL_OPTIONS "${FILE}" || EXIT_CODE=$? ;} 2>/dev/null ; wait ;
+	# Part 2: Run specific regression tests for known typos
+	printf "::debug::%s\n" "Running regression tests for specific typos." ;
+	for TYPO_PAIR in "${SPECIFIC_TYPOS[@]}"; do
+		# Split the pair into typo and correction
+		TYPO="${TYPO_PAIR%%:*}"
+		CORRECTION="${TYPO_PAIR##*:}"
+		
+		# Check for the specific typo
+		if grep -q "$TYPO" "$FILE" 2>/dev/null; then
+			printf "::error file=%s,title=Regression Test Failed::%s\n" "${FILE}" "Found typo '$TYPO' (should be '$CORRECTION')" >&2
+			EXIT_CODE=2
+			
+			# Auto-correct if --fix is provided
+			if [[ "$1" == "--fix" ]]; then
+				if sed -i "s/$TYPO/$CORRECTION/g" "${FILE}" 2>/dev/null; then
+					printf "::notice file=%s,title=Auto-corrected::%s\n" "$FILE" "Fixed typo '$TYPO' to '$CORRECTION'"
+				fi
+			fi
+		fi
+		unset TYPO 2>/dev/null || : ;
+		unset CORRECTION 2>/dev/null || : ;
+	done
 	printf "::endgroup::\n" ;
 done