fix: improve Vale style checking robustness

EdwardAngert · EdwardAngert · commit 0b8726279b31 · 2025-04-24T14:39:56.000-04:00
- Use xargs to properly handle filenames with spaces
- Add more robust error handling for JSON parsing
- Handle empty output files explicitly
- Add truncation for large issue lists
- Improve jq handling with try/catch pattern
diff --git a/.github/docs/actions/docs-core/action.yaml b/.github/docs/actions/docs-core/action.yaml
@@ -779,25 +779,32 @@ runs:
         echo "Running Vale with config .github/docs/vale/.vale.ini"
         if [ -n "$FILES_TO_CHECK" ]; then
           echo "Using space-separated file list for Vale"
-          vale --no-exit --output=JSON --config=.github/docs/vale/.vale.ini $FILES_TO_CHECK > "$TEMP_DIR/vale_results.json" 2>/dev/null || true
+          # Use xargs to properly handle each file as a separate argument
+          echo "$FILES_TO_CHECK" | xargs vale --no-exit --output=JSON --config=.github/docs/vale/.vale.ini > "$TEMP_DIR/vale_results.json" 2>/dev/null || true
         elif [ -n "$MD_FILES_CSV" ]; then
           # Convert CSV to space-separated for command line
           echo "Using converted CSV file list for Vale"
-          FILE_LIST=$(echo "$MD_FILES_CSV" | tr ',' ' ')
-          vale --no-exit --output=JSON --config=.github/docs/vale/.vale.ini $FILE_LIST > "$TEMP_DIR/vale_results.json" 2>/dev/null || true
+          # Use xargs to properly handle each file as a separate argument
+          echo "$MD_FILES_CSV" | tr ',' '\n' | xargs vale --no-exit --output=JSON --config=.github/docs/vale/.vale.ini > "$TEMP_DIR/vale_results.json" 2>/dev/null || true
         else
           echo "No files to check with Vale"
           echo "[]" > "$TEMP_DIR/vale_results.json"
         fi
     
         # Process results from JSON output
         if [ -f "$TEMP_DIR/vale_results.json" ]; then
+          # Check if the file is empty (which is valid but not valid JSON)
+          if [ ! -s "$TEMP_DIR/vale_results.json" ]; then
+            echo "Empty results file, treating as success"
+            echo "[]" > "$TEMP_DIR/vale_results.json"
+          fi
+          
           # Make sure the JSON output is valid
           if jq empty "$TEMP_DIR/vale_results.json" 2>/dev/null; then
             VALE_OUTPUT=$(cat "$TEMP_DIR/vale_results.json")
             
-            # Check if there are any issues
-            if [ "$VALE_OUTPUT" = "[]" ] || [ "$(echo "$VALE_OUTPUT" | jq 'length')" -eq 0 ]; then
+            # Handle empty array case explicitly 
+            if [ "$VALE_OUTPUT" = "" ] || [ "$VALE_OUTPUT" = "[]" ] || [ "$(echo "$VALE_OUTPUT" | jq 'length')" -eq 0 ]; then
               echo "Vale check passed: No style issues found"
               echo "status=success" >> $GITHUB_OUTPUT
               echo "message=No style issues found in $FILE_COUNT files" >> $GITHUB_OUTPUT
@@ -806,16 +813,18 @@ runs:
               ISSUE_COUNT=$(echo "$VALE_OUTPUT" | jq 'length')
               echo "Vale found $ISSUE_COUNT style issues in $FILE_COUNT files"
               
-              # Group issues by file for better readability
-              echo "$VALE_OUTPUT" | jq -r 'group_by(.Path) | .[] | .[0].Path + ":" + (. | length | tostring) + " issues"'
+              # Group issues by file for better readability (with safety check)
+              echo "$VALE_OUTPUT" | jq -r 'try (group_by(.Path) | .[] | .[0].Path + ":" + (. | length | tostring) + " issues") // "Could not group issues"'
               
               # Show details of first 10 issues
               echo "First 10 issues (detail):"
-              echo "$VALE_OUTPUT" | jq -r '.[] | "\(.Path):\(.Line):\(.Column) - \(.Message) (\(.Check))"' | head -10
+              echo "$VALE_OUTPUT" | jq -r 'try (.[] | "\(.Path):\(.Line):\(.Column) - \(.Message) (\(.Check))") // "Error displaying issues"' | head -10
               
               echo "status=warning" >> $GITHUB_OUTPUT
               echo "message=Found $ISSUE_COUNT style issues in $FILE_COUNT files" >> $GITHUB_OUTPUT
-              echo "issues=$VALE_OUTPUT" >> $GITHUB_OUTPUT
+              # Limit the size of the issues output to avoid any GitHub Actions limits
+              ISSUES_TRUNCATED=$(echo "$VALE_OUTPUT" | jq 'if length > 50 then .[0:50] else . end')
+              echo "issues=$ISSUES_TRUNCATED" >> $GITHUB_OUTPUT
             fi
           else
             echo "Warning: Vale produced invalid JSON output, treating as success"
