feat(action): add suggestion column to PR comment table (#33)

ddnetters · web-flow · commit 26a327d107a0 · 2026-02-02T15:33:46.000+01:00
When validation fails, the PR comment now includes a Suggestion column
that shows recommended fixes from the style checker. This helps
developers quickly understand what corrections to make.
diff --git a/src/comment-formatter.ts b/src/comment-formatter.ts
@@ -1,8 +1,9 @@
-import { ValidatorOutput, ValidationResult } from './types';
+import { ValidatorOutput, ValidationResult, StyleViolation } from './types';
 
 const MAX_CONTENT_LENGTH = 50;
 const MAX_ISSUES_PER_FILE = 10;
 const MAX_FILES = 10;
+const MAX_SUGGESTION_LENGTH = 100;
 
 function truncate(str: string, maxLength: number): string {
   if (str.length <= maxLength) return str;
@@ -27,6 +28,22 @@ function groupByFile(results: ValidationResult[]): Map<string, ValidationResult[
   return grouped;
 }
 
+function formatSuggestion(details?: StyleViolation[]): string {
+  if (!details || details.length === 0) {
+    return '-';
+  }
+
+  const suggestions = details
+    .filter(d => d.suggestion)
+    .map(d => escapeHtml(truncate(d.suggestion!, MAX_SUGGESTION_LENGTH)));
+
+  if (suggestions.length === 0) {
+    return '-';
+  }
+
+  return suggestions.join('; ');
+}
+
 export function formatPRComment(output: ValidatorOutput): string {
   const { results, summary } = output;
   const icon = summary.pass ? '✅' : '❌';
@@ -61,20 +78,21 @@ export function formatPRComment(output: ValidatorOutput): string {
     comment += `<summary><code>${file}</code> (${issueCount} issue${issueCount > 1 ? 's' : ''})</summary>\n\n`;
 
     // Table header
-    comment += `| Line | Content | Issue |\n`;
-    comment += `|------|---------|-------|\n`;
+    comment += `| Line | Content | Issue | Suggestion |\n`;
+    comment += `|------|---------|-------|------------|\n`;
 
     // Table rows
     const displayResults = fileResults.slice(0, MAX_ISSUES_PER_FILE);
     for (const result of displayResults) {
       const content = escapeHtml(truncate(result.content, MAX_CONTENT_LENGTH));
       const message = escapeHtml(result.message);
-      comment += `| ${result.line} | \`${content}\` | ${message} |\n`;
+      const suggestion = formatSuggestion(result.details);
+      comment += `| ${result.line} | \`${content}\` | ${message} | ${suggestion} |\n`;
     }
 
     if (fileResults.length > MAX_ISSUES_PER_FILE) {
       const remaining = fileResults.length - MAX_ISSUES_PER_FILE;
-      comment += `| ... | *${remaining} more* | |\n`;
+      comment += `| ... | *${remaining} more* | | |\n`;
     }
 
     comment += `\n</details>\n\n`;
