make error messages prettier

Author: MarcoWang3

packages/amazonq/src/lsp/autoDebug/controller.ts

@@ -7,27 +7,23 @@ import * as vscode from 'vscode'
 import { getLogger, randomUUID } from 'aws-core-vscode/shared'
 import { AutoDebugLspClient } from './lsp/autoDebugLspClient'
 import { mapDiagnosticSeverity } from './shared/diagnosticUtils'
+import { ErrorContextFormatter } from './diagnostics/errorContext'
+import { Problem } from './diagnostics/problemDetector'
 
 export interface AutoDebugConfig {
     readonly enabled: boolean
     readonly excludedSources: string[]
     readonly severityFilter: ('error' | 'warning' | 'info' | 'hint')[]
 }
 
-export interface Problem {
-    readonly uri: vscode.Uri
-    readonly diagnostic: vscode.Diagnostic
-    readonly severity: 'error' | 'warning' | 'info' | 'hint'
-    readonly source: string
-}
-
 /**
  * Simplified controller for Amazon Q Auto Debug system.
  * Focuses on context menu and quick fix functionality without workspace-wide monitoring.
  */
 export class AutoDebugController implements vscode.Disposable {
     private readonly logger = getLogger()
     private readonly lspClient: AutoDebugLspClient
+    private readonly errorFormatter: ErrorContextFormatter
     private readonly disposables: vscode.Disposable[] = []
 
     private config: AutoDebugConfig
@@ -41,6 +37,7 @@ export class AutoDebugController implements vscode.Disposable {
         }
 
         this.lspClient = new AutoDebugLspClient(client, encryptionKey)
+        this.errorFormatter = new ErrorContextFormatter()
     }
 
     /**
@@ -79,6 +76,7 @@ export class AutoDebugController implements vscode.Disposable {
                 diagnostic,
                 severity: mapDiagnosticSeverity(diagnostic.severity),
                 source: diagnostic.source || 'unknown',
+                isNew: false,
             }))
 
             // Create fix message
@@ -131,6 +129,7 @@ export class AutoDebugController implements vscode.Disposable {
                 diagnostic,
                 severity: mapDiagnosticSeverity(diagnostic.severity),
                 source: diagnostic.source || 'unknown',
+                isNew: false,
             }))
 
             // Create fix message
@@ -170,6 +169,7 @@ export class AutoDebugController implements vscode.Disposable {
                 diagnostic,
                 severity: mapDiagnosticSeverity(diagnostic.severity),
                 source: diagnostic.source || 'unknown',
+                isNew: false,
             }))
 
             // Create explanation message
@@ -182,35 +182,17 @@ export class AutoDebugController implements vscode.Disposable {
     }
 
     private createFixMessage(filePath: string, problems: Problem[]): string {
-        const parts = [`Please help me fix the following errors in ${filePath}`]
-
-        for (const problem of problems) {
-            const line = problem.diagnostic.range.start.line + 1
-            const column = problem.diagnostic.range.start.character + 1
-            const source = problem.source !== 'unknown' ? problem.source : 'Unknown'
-            parts.push(
-                `ERROR: ${problem.diagnostic.message} Location: Line ${line}, Column ${column} Source: ${source}`
-            )
-        }
+        const workspaceRoot = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath || ''
+        const formattedProblems = this.errorFormatter.formatProblemsString(problems, workspaceRoot)
 
-        return parts.join('\n')
+        return `Please help me fix the following errors in ${filePath}:${formattedProblems}`
     }
 
     private createExplainMessage(filePath: string, problems: Problem[]): string {
-        const parts = [
-            `Please explain the following problems in ${filePath}. DO NOT edit files. ONLY provide explanation`,
-        ]
-
-        for (const problem of problems) {
-            const line = problem.diagnostic.range.start.line + 1
-            const column = problem.diagnostic.range.start.character + 1
-            const source = problem.source !== 'unknown' ? problem.source : 'Unknown'
-            parts.push(
-                `${problem.severity.toUpperCase()}: ${problem.diagnostic.message} Location: Line ${line}, Column ${column} Source: ${source}`
-            )
-        }
+        const workspaceRoot = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath || ''
+        const formattedProblems = this.errorFormatter.formatProblemsString(problems, workspaceRoot)
 
-        return parts.join('\n')
+        return `Please explain the following problems in ${filePath}. DO NOT edit files. ONLY provide explanation:${formattedProblems}`
     }
 
     /**

packages/amazonq/src/lsp/autoDebug/diagnostics/errorContext.ts

@@ -114,22 +114,24 @@ export class ErrorContextFormatter {
     }
 
     /**
-     * Creates a problems string similar to the reference implementation
+     * Creates a problems string with Markdown formatting for better readability
      */
     public formatProblemsString(problems: Problem[], cwd: string): string {
         let result = ''
         const fileGroups = this.groupProblemsByFile(problems)
 
         for (const [filePath, fileProblems] of fileGroups.entries()) {
             if (fileProblems.length > 0) {
-                result += `\n\n${path.relative(cwd, filePath)}`
+                result += `\n\n**${path.relative(cwd, filePath)}**\n\n`
 
+                // Group problems into a code block for better formatting
+                result += '```\n'
                 for (const problem of fileProblems) {
-                    const label = this.getSeverityLabel(problem.severity)
                     const line = problem.diagnostic.range.start.line + 1
-                    const source = problem.source ? `${problem.source} ` : ''
-                    result += `\n- [${source}${label}] Line ${line}: ${problem.diagnostic.message}`
+                    const source = problem.source ? `${problem.source}` : 'Unknown'
+                    result += `[${source}] Line ${line}: ${problem.diagnostic.message}\n`
                 }
+                result += '```'
             }
         }
 
@@ -248,19 +250,4 @@ export class ErrorContextFormatter {
 
         return groups
     }
-
-    private getSeverityLabel(severity: string): string {
-        switch (severity) {
-            case 'error':
-                return 'ERROR'
-            case 'warning':
-                return 'WARN'
-            case 'info':
-                return 'INFO'
-            case 'hint':
-                return 'HINT'
-            default:
-                return 'UNKNOWN'
-        }
-    }
 }