[RHIDP#12789]: Clean up CQA output: suppress pass noise, unify formats, sentence case (#1954)

themr0c · claude · web-flow · commit 1f0de554b01c · 2026-03-20T17:14:11.000+01:00
Co-authored-by: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/build/scripts/cqa-00-directory-structure.sh b/build/scripts/cqa-00-directory-structure.sh
@@ -273,7 +273,7 @@ fi
 # Full repo mode (default — no positional arg)
 # ═══════════════════════════════════════════════════════════════════
 
-cqa_header "0" "Verify Directory Structure (<category>_<context> naming)"
+cqa_header "0" "Verify directory structure (<category>_<context> naming)"
 
 # ── Phase 0: Pre-computation ──
 
diff --git a/build/scripts/cqa-00-orphaned-modules.sh b/build/scripts/cqa-00-orphaned-modules.sh
@@ -43,7 +43,7 @@ for arg in "$@"; do
     _prev_arg="$arg"
 done
 
-cqa_header "0" "Find Orphaned Modules and Images"
+cqa_header "0" "Find orphaned modules and images"
 
 # ── Collect all include:: references ──
 declare -A INCLUDED_BASENAMES=()
diff --git a/build/scripts/cqa-01-asciidoctor-dita-vale.sh b/build/scripts/cqa-01-asciidoctor-dita-vale.sh
@@ -60,7 +60,7 @@ except: pass
 _cqa01_check() {
     local target="$1"
 
-    cqa_header "1" "Vale AsciiDoc DITA Compliance" "$target"
+    cqa_header "1" "Vale AsciiDoc DITA compliance" "$target"
 
     # Collect files excluding attributes.adoc
     local vale_files=()
diff --git a/build/scripts/cqa-02-assembly-structure.sh b/build/scripts/cqa-02-assembly-structure.sh
@@ -65,7 +65,7 @@ _fix_context_line() {
 _cqa02_check() {
     local target="$1"
 
-    cqa_header "2" "Verify Assembly Structure" "$target"
+    cqa_header "2" "Verify assembly structure" "$target"
 
     # Filter to assembly files only
     local assembly_files=()
diff --git a/build/scripts/cqa-03-content-is-modularized.sh b/build/scripts/cqa-03-content-is-modularized.sh
@@ -116,7 +116,7 @@ _fix_section_lists() {
 _cqa03_check() {
     local target="$1"
 
-    cqa_header "3" "Verify Content Type Metadata" "$target"
+    cqa_header "3" "Verify content type metadata" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ -f "$file" ]] || continue
diff --git a/build/scripts/cqa-04-modules-use-official-templates.sh b/build/scripts/cqa-04-modules-use-official-templates.sh
@@ -28,7 +28,7 @@ cqa_parse_args "$0" "$@"
 _cqa04_check() {
     local target="$1"
 
-    cqa_header "4" "Verify Module Templates" "$target"
+    cqa_header "4" "Verify module templates" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-05-modular-elements-checklist.sh b/build/scripts/cqa-05-modular-elements-checklist.sh
@@ -27,7 +27,7 @@ readonly PATTERN_BLOCK_TITLE='^\.[A-Z]'
 _cqa05_check() {
     local target="$1"
 
-    cqa_header "5" "Verify Required Modular Elements" "$target"
+    cqa_header "5" "Verify required modular elements" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ -f "$file" ]] || continue
diff --git a/build/scripts/cqa-06-assemblies-use-the-official-template-assemblies-ar.sh b/build/scripts/cqa-06-assemblies-use-the-official-template-assemblies-ar.sh
@@ -25,7 +25,7 @@ cqa_parse_args "$0" "$@"
 _cqa06_check() {
     local target="$1"
 
-    cqa_header "6" "Verify Assemblies Follow Official Template (One User Story)" "$target"
+    cqa_header "6" "Verify assemblies follow official template (one user story)" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-07-toc-max-3-levels.sh b/build/scripts/cqa-07-toc-max-3-levels.sh
@@ -23,7 +23,7 @@ cqa_parse_args "$0" "$@"
 _cqa07_check() {
     local target="$1"
 
-    cqa_header "7" "Verify TOC Depth (Max 3 Levels)" "$target"
+    cqa_header "7" "Verify TOC depth (max 3 levels)" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-08-short-description-content.sh b/build/scripts/cqa-08-short-description-content.sh
@@ -54,7 +54,7 @@ SELF_REF_REMOVABLE=(
 _cqa08_check() {
     local target="$1"
 
-    cqa_header "8" "Verify Short Description Content Quality" "$target"
+    cqa_header "8" "Verify short description content quality" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-09-short-description-format.sh b/build/scripts/cqa-09-short-description-format.sh
@@ -24,7 +24,7 @@ cqa_parse_args "$0" "$@"
 _cqa09_check() {
     local target="$1"
 
-    cqa_header "9" "Verify Short Description Format" "$target"
+    cqa_header "9" "Verify short description format" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-10-titles-are-brief-complete-and-descriptive.sh b/build/scripts/cqa-10-titles-are-brief-complete-and-descriptive.sh
@@ -304,7 +304,7 @@ _process_file() {
 _cqa10_check() {
     local target="$1"
 
-    cqa_header "10" "Verify Titles Are Brief, Complete, and Descriptive" "$target"
+    cqa_header "10" "Verify titles are brief, complete, and descriptive" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-11-procedures-prerequisites.sh b/build/scripts/cqa-11-procedures-prerequisites.sh
@@ -25,7 +25,7 @@ cqa_parse_args "$0" "$@"
 _cqa11_check() {
     local target="$1"
 
-    cqa_header "11" "Verify Procedure Prerequisites" "$target"
+    cqa_header "11" "Verify procedure prerequisites" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-12-content-is-grammatically-correct-and-follows-rules.sh b/build/scripts/cqa-12-content-is-grammatically-correct-and-follows-rules.sh
@@ -25,7 +25,7 @@ cqa_parse_args "$0" "$@"
 _cqa12_check() {
     local target="$1"
 
-    cqa_header "12" "Verify Grammar and Style (Vale)" "$target"
+    cqa_header "12" "Verify grammar and style (Vale)" "$target"
 
     # Filter out attributes.adoc from collected files
     local vale_files=()
diff --git a/build/scripts/cqa-13-information-is-conveyed-using-the-correct-content.sh b/build/scripts/cqa-13-information-is-conveyed-using-the-correct-content.sh
@@ -26,7 +26,7 @@ cqa_parse_args "$0" "$@"
 _cqa13_check() {
     local target="$1"
 
-    cqa_header "13" "Verify Content Matches Declared Type" "$target"
+    cqa_header "13" "Verify content matches declared type" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-14-no-broken-links.sh b/build/scripts/cqa-14-no-broken-links.sh
@@ -21,7 +21,7 @@ cqa_parse_args "$0" "$@"
 _cqa14_check() {
     local target="$1"
 
-    cqa_header "14" "Verify No Broken Links" "$target"
+    cqa_header "14" "Verify no broken links" "$target"
 
     # Resolve :imagesdir: from the target, then fall back to artifacts/attributes.adoc
     local imagesdir=""
diff --git a/build/scripts/cqa-15-redirects.sh b/build/scripts/cqa-15-redirects.sh
@@ -19,7 +19,7 @@ cqa_parse_args "$0" "$@"
 _cqa15_check() {
     local target="$1"
 
-    cqa_header "15" "Check Redirects" "$target"
+    cqa_header "15" "Check redirects" "$target"
 
     cqa_file_start "$target"
 
diff --git a/build/scripts/cqa-16-official-product-names-are-used.sh b/build/scripts/cqa-16-official-product-names-are-used.sh
@@ -82,7 +82,7 @@ PATTERNS=(
 _cqa16_check() {
     local target="$1"
 
-    cqa_header "16" "Verify Official Product Names" "$target"
+    cqa_header "16" "Verify official product names" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-17-includes-appropriate-legal-approved-disclaimers-f.sh b/build/scripts/cqa-17-includes-appropriate-legal-approved-disclaimers-f.sh
@@ -25,7 +25,7 @@ cqa_parse_args "$0" "$@"
 _cqa17_check() {
     local target="$1"
 
-    cqa_header "17" "Verify Legal Disclaimers for Preview Features" "$target"
+    cqa_header "17" "Verify legal disclaimers for preview features" "$target"
 
     for file in "${_CQA_COLLECTED_FILES[@]}"; do
         [[ "$file" != *.adoc ]] && continue
diff --git a/build/scripts/cqa-lib.sh b/build/scripts/cqa-lib.sh
@@ -340,17 +340,7 @@ _cqa_ensure_file_header() {
 
 # Report a passing check
 cqa_pass() {
-    local line="${1:-}"
-    local desc="$2"
     _CQA_TOTAL_PASS=$((_CQA_TOTAL_PASS + 1))
-    if [[ "$CQA_FORMAT" == "$_CQA_FMT_CHECKLIST" ]]; then
-        if [[ -n "$line" ]]; then
-            echo -e "- [x] Line ${line}: ${desc}"
-        else
-            echo -e "- [x] ${desc}"
-        fi
-    fi
-    # SARIF: passes are not reported
     return 0
 }
 
@@ -448,10 +438,6 @@ cqa_delegated() {
 
 # Mark file as all-passed (call if no issues were found for the file)
 cqa_file_pass() {
-    local file="${1:-$_CQA_CURRENT_FILE}"
-    if [[ "$CQA_FORMAT" == "$_CQA_FMT_CHECKLIST" && "$_CQA_CURRENT_FILE_HAS_ISSUES" == false && "$CQA_ALL_MODE" == false ]]; then
-        echo -e "${_C_GREEN}-  [x]${_C_NC} ${file}"
-    fi
     return 0
 }
 
diff --git a/build/scripts/cqa.sh b/build/scripts/cqa.sh
@@ -99,88 +99,58 @@ SARIF_EOF
     exit 0
 fi
 
-# ── Summary checklist mode (--all) ──
-if [[ "$CQA_ALL_MODE" == true ]]; then
-    echo "## CQA Summary Checklist"
-    echo ""
-
-    for script in "${CQA_SCRIPTS[@]}"; do
-        script_path="${CQA_SCRIPT_DIR}/${script}"
-        [[ -x "$script_path" ]] || continue
-
-        total=$((total + 1))
-
-        # Extract CQA number from filename (strip prefix and leading zeros)
-        cqa_num="${script#cqa-}"
-        cqa_num="${cqa_num%%-*}"
-        cqa_num=$((10#$cqa_num))
-
-        # Run script, capture output
-        output=$("$script_path" "${pass_args[@]}" 2>&1 || true)
-
-        # Extract the CQA header line for the check name
-        cqa_name=$(echo "$output" | grep "^## CQA-" | head -1 | sed 's/^## CQA-[0-9]*: //')
-
-        # Collect issue lines (AUTOFIX, MANUAL, FIXED, delegated) — file path is included by cqa-lib.sh
-        script_issues=$(echo "$output" | grep -E '^- \[ \] \[' | grep -E '\[AUTOFIX\]|\[MANUAL\]|\[-> CQA' || true)
-
-        if [[ -z "$script_issues" ]]; then
-            echo "- [x] **CQA-${cqa_num}:** ${cqa_name}"
-            passed=$((passed + 1))
-        else
-            echo "- [ ] **CQA-${cqa_num}:** ${cqa_name}"
-            failed=$((failed + 1))
-
-            echo "$script_issues" | sed 's/^- \[ \] //' | while IFS= read -r line; do
-                echo "    - ${line}"
-            done
-        fi
-    done
-
-    echo ""
-    echo "---"
-    echo "**Total:** ${total} checks | ${passed} passed | ${failed} with issues"
-
-    if [[ $failed -gt 0 ]]; then
-        echo ""
-        echo "To auto-fix what can be auto-fixed, run: \`./build/scripts/cqa.sh --fix --all\`"
-        echo ""
-        echo "To fix remaining issues, copy-paste this prompt to Claude: \`Run ./build/scripts/cqa.sh --all, then for each failing CQA check, read the matching .claude/skills/cqa-*.md skill file and fix the [MANUAL] issues following the skill instructions.\`"
-        exit 1
-    fi
-    exit 0
-fi
+# ── Checklist mode (both --all and single title) ──
+echo "## CQA Summary Checklist"
+echo ""
 
-# ── Verbose mode (single title): show full output from each script ──
 for script in "${CQA_SCRIPTS[@]}"; do
     script_path="${CQA_SCRIPT_DIR}/${script}"
-    if [[ ! -x "$script_path" ]]; then
-        echo "WARNING: Script not found or not executable: $script_path" >&2
-        continue
-    fi
+    [[ -x "$script_path" ]] || continue
 
     total=$((total + 1))
-    echo ""
-    echo "========================================"
 
-    if "$script_path" "${pass_args[@]}"; then
+    # Extract CQA number from filename (strip prefix and leading zeros)
+    cqa_num="${script#cqa-}"
+    cqa_num="${cqa_num%%-*}"
+    cqa_num=$((10#$cqa_num))
+
+    # Run script, capture output
+    output=$("$script_path" "${pass_args[@]}" 2>&1 || true)
+
+    # Extract the CQA header line for the check name; fall back to script filename
+    cqa_name=$(echo "$output" | grep "^## CQA" | head -1 | sed 's/^## CQA[# -]*[0-9]*[: ]*//')
+    if [[ -z "$cqa_name" ]]; then
+        cqa_name="${script#cqa-[0-9]*-}"
+        cqa_name="${cqa_name%.sh}"
+        cqa_name="${cqa_name//-/ }"
+        # Sentence case
+        cqa_name="$(echo "${cqa_name:0:1}" | tr '[:lower:]' '[:upper:]')${cqa_name:1}"
+    fi
+
+    # Collect issue lines (AUTOFIX, MANUAL, FIXED, delegated) — file path is included by cqa-lib.sh
+    script_issues=$(echo "$output" | grep -E '^- \[ \] \[' | grep -E '\[AUTOFIX\]|\[MANUAL\]|\[-> CQA' || true)
+
+    if [[ -z "$script_issues" ]]; then
+        echo "- [x] **CQA-${cqa_num}:** ${cqa_name}"
         passed=$((passed + 1))
     else
+        echo "- [ ] **CQA-${cqa_num}:** ${cqa_name}"
         failed=$((failed + 1))
+
+        echo "$script_issues" | sed 's/^- \[ \] //' | while IFS= read -r line; do
+            echo "    - ${line}"
+        done
     fi
 done
 
 echo ""
-echo "========================================"
-echo "## CQA Summary"
-echo "Scripts run: $total | Passed: $passed | Failed: $failed"
+echo "---"
+echo "**Total:** ${total} checks | ${passed} passed | ${failed} with issues"
 
 if [[ $failed -gt 0 ]]; then
     echo ""
-    echo "To auto-fix what can be auto-fixed, run:"
-    echo "  ./build/scripts/cqa.sh --fix ${pass_args[*]}"
+    echo "To auto-fix what can be auto-fixed, run: \`./build/scripts/cqa.sh --fix ${pass_args[*]}\`"
     echo ""
-    echo "To fix remaining issues, copy-paste this prompt to Claude:"
-    echo "  Run ./build/scripts/cqa.sh ${pass_args[*]}, then for each failing CQA check, read the matching .claude/skills/cqa-*.md skill file and fix the [MANUAL] issues following the skill instructions."
+    echo "To fix remaining issues, copy-paste this prompt to Claude: \`Run ./build/scripts/cqa.sh ${pass_args[*]}, then for each failing CQA check, read the matching .claude/skills/cqa-*.md skill file and fix the [MANUAL] issues following the skill instructions.\`"
     exit 1
 fi
diff --git a/build/scripts/lint-scripts.sh b/build/scripts/lint-scripts.sh
@@ -7,12 +7,11 @@ set -e
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
-echo "## Lint: CQA Scripts"
+echo "## Lint: CQA scripts"
 echo ""
 
 errors=0
 for script in "$SCRIPT_DIR"/*.sh; do
-    bn=$(basename "$script")
     if ! shellcheck -S warning -e SC2034,SC2329,SC1091 "$script" 2>/dev/null; then
         errors=$((errors + 1))
     fi
