Wait for diagnostics to stabilize before returning them

Author: cte

src/integrations/diagnostics/index.ts

@@ -1,5 +1,6 @@
-import * as vscode from "vscode"
 import * as path from "path"
+
+import * as vscode from "vscode"
 import deepEqual from "fast-deep-equal"
 
 export function getNewDiagnostics(
@@ -21,68 +22,31 @@ export function getNewDiagnostics(
 	return newProblems
 }
 
-// Usage:
-// const oldDiagnostics = // ... your old diagnostics array
-// const newDiagnostics = // ... your new diagnostics array
-// const newProblems = getNewDiagnostics(oldDiagnostics, newDiagnostics);
+// Expected output:
+// New problems:
+// File: /path/to/file1.ts
+// - New error in file1 (2:2)
+// File: /path/to/file3.ts
+// - New error in file3 (1:1)
 
-// Example usage with mocks:
-//
-// // Mock old diagnostics
-// const oldDiagnostics: [vscode.Uri, vscode.Diagnostic[]][] = [
-//     [vscode.Uri.file("/path/to/file1.ts"), [
-//         new vscode.Diagnostic(new vscode.Range(0, 0, 0, 10), "Old error in file1", vscode.DiagnosticSeverity.Error)
-//     ]],
-//     [vscode.Uri.file("/path/to/file2.ts"), [
-//         new vscode.Diagnostic(new vscode.Range(5, 5, 5, 15), "Old warning in file2", vscode.DiagnosticSeverity.Warning)
-//     ]]
-// ];
-//
-// // Mock new diagnostics
-// const newDiagnostics: [vscode.Uri, vscode.Diagnostic[]][] = [
-//     [vscode.Uri.file("/path/to/file1.ts"), [
-//         new vscode.Diagnostic(new vscode.Range(0, 0, 0, 10), "Old error in file1", vscode.DiagnosticSeverity.Error),
-//         new vscode.Diagnostic(new vscode.Range(2, 2, 2, 12), "New error in file1", vscode.DiagnosticSeverity.Error)
-//     ]],
-//     [vscode.Uri.file("/path/to/file2.ts"), [
-//         new vscode.Diagnostic(new vscode.Range(5, 5, 5, 15), "Old warning in file2", vscode.DiagnosticSeverity.Warning)
-//     ]],
-//     [vscode.Uri.file("/path/to/file3.ts"), [
-//         new vscode.Diagnostic(new vscode.Range(1, 1, 1, 11), "New error in file3", vscode.DiagnosticSeverity.Error)
-//     ]]
-// ];
-//
-// const newProblems = getNewProblems(oldDiagnostics, newDiagnostics);
-//
-// console.log("New problems:");
-// for (const [uri, diagnostics] of newProblems) {
-//     console.log(`File: ${uri.fsPath}`);
-//     for (const diagnostic of diagnostics) {
-//         console.log(`- ${diagnostic.message} (${diagnostic.range.start.line}:${diagnostic.range.start.character})`);
-//     }
-// }
-//
-// // Expected output:
-// // New problems:
-// // File: /path/to/file1.ts
-// // - New error in file1 (2:2)
-// // File: /path/to/file3.ts
-// // - New error in file3 (1:1)
-
-// will return empty string if no problems with the given severity are found
+// Will return empty string if no problems with the given severity are found.
 export async function diagnosticsToProblemsString(
 	diagnostics: [vscode.Uri, vscode.Diagnostic[]][],
 	severities: vscode.DiagnosticSeverity[],
 	cwd: string,
 ): Promise<string> {
 	const documents = new Map<vscode.Uri, vscode.TextDocument>()
 	let result = ""
+
 	for (const [uri, fileDiagnostics] of diagnostics) {
 		const problems = fileDiagnostics.filter((d) => severities.includes(d.severity))
+
 		if (problems.length > 0) {
 			result += `\n\n${path.relative(cwd, uri.fsPath).toPosix()}`
+
 			for (const diagnostic of problems) {
 				let label: string
+
 				switch (diagnostic.severity) {
 					case vscode.DiagnosticSeverity.Error:
 						label = "Error"
@@ -99,6 +63,7 @@ export async function diagnosticsToProblemsString(
 					default:
 						label = "Diagnostic"
 				}
+
 				const line = diagnostic.range.start.line + 1 // VSCode lines are 0-indexed
 				const source = diagnostic.source ? `${diagnostic.source} ` : ""
 				const document = documents.get(uri) || (await vscode.workspace.openTextDocument(uri))
@@ -108,5 +73,6 @@ export async function diagnosticsToProblemsString(
 			}
 		}
 	}
+
 	return result.trim()
 }