Show swiftc diagnostics with square brackets (#1325)

* Show swiftc diagnostics with square brackets

Display the full diagnostic message instead of stopping at backslashes
or square brackets and update the diagnostics test case to check for
this.

Issue: #1312

* Remove [-Wcode] warnings from swiftc diagnostics

Remove any additional [-Wcode] warnings that swiftc adds to messages
to allow for merging diagnostics with SourceKit.

Author: rbenegal

assets/test/diagnostics/Sources/main.swift

@@ -13,6 +13,8 @@ repeat {
   print(line ?? "nil")
 } while line != nil;
 
+let dictionary: [String: String] = []
+
 #if canImport(Testing)
 import Testing
 #expect(try myFunc() != 0)

assets/test/diagnosticsCpp/Sources/MyPoint/MyPoint.cpp

@@ -6,4 +6,8 @@ int func() {
     p->y = bar;
     p.z = 2
     return p.x;
-}
+}
+
+int main() {
+    return;
+}

src/DiagnosticsManager.ts

@@ -355,13 +355,14 @@ export class DiagnosticsManager implements vscode.Disposable {
         line: string
     ): ParsedDiagnostic | vscode.DiagnosticRelatedInformation | undefined {
         const diagnosticRegex =
-            /^(?:\S+\s+)?(.*?):(\d+)(?::(\d+))?:\s+(warning|error|note):\s+([^\\[]*)/g;
+            /^(?:\S+\s+)?(.*?):(\d+)(?::(\d+))?:\s+(warning|error|note):\s+(.*)$/g;
+        const switfcExtraWarningsRegex = /\[-W.*?\]/g;
         const match = diagnosticRegex.exec(line);
         if (!match) {
             return;
         }
         const uri = vscode.Uri.file(match[1]).fsPath;
-        const message = this.capitalize(match[5]).trim();
+        const message = this.capitalize(match[5]).replace(switfcExtraWarningsRegex, "").trim();
         const range = this.range(match[2], match[3]);
         const severity = this.severity(match[4]);
         if (severity === vscode.DiagnosticSeverity.Information) {

test/integration-tests/DiagnosticsManager.test.ts

@@ -181,6 +181,13 @@ suite("DiagnosticsManager Test Suite", async function () {
             );
             expectedMainErrorDiagnostic.source = "swiftc";
 
+            const expectedMainDictErrorDiagnostic = new vscode.Diagnostic(
+                new vscode.Range(new vscode.Position(15, 35), new vscode.Position(15, 35)),
+                "Use [:] to get an empty dictionary literal",
+                vscode.DiagnosticSeverity.Error
+            );
+            expectedMainDictErrorDiagnostic.source = "swiftc";
+
             const expectedFuncErrorDiagnostic: vscode.Diagnostic = new vscode.Diagnostic(
                 new vscode.Range(new vscode.Position(1, 4), new vscode.Position(1, 4)),
                 "Cannot find 'baz' in scope",
@@ -189,7 +196,7 @@ suite("DiagnosticsManager Test Suite", async function () {
             expectedFuncErrorDiagnostic.source = "swiftc";
 
             const expectedMacroDiagnostic = new vscode.Diagnostic(
-                new vscode.Range(new vscode.Position(17, 26), new vscode.Position(17, 26)),
+                new vscode.Range(new vscode.Position(19, 26), new vscode.Position(19, 26)),
                 "No calls to throwing functions occur within 'try' expression",
                 vscode.DiagnosticSeverity.Warning
             );
@@ -238,6 +245,7 @@ suite("DiagnosticsManager Test Suite", async function () {
                         [mainUri.fsPath]: [
                             expectedWarningDiagnostic,
                             expectedMainErrorDiagnostic,
+                            expectedMainDictErrorDiagnostic,
                             ...(workspaceContext.swiftVersion.isGreaterThanOrEqual(
                                 new Version(6, 0, 0)
                             )
@@ -269,7 +277,11 @@ suite("DiagnosticsManager Test Suite", async function () {
 
                 await Promise.all([
                     waitForDiagnostics({
-                        [mainUri.fsPath]: [expectedWarningDiagnostic, expectedMainErrorDiagnostic], // Should have parsed correct severity
+                        [mainUri.fsPath]: [
+                            expectedWarningDiagnostic,
+                            expectedMainErrorDiagnostic,
+                            expectedMainDictErrorDiagnostic,
+                        ], // Should have parsed correct severity
                         [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
                     }),
                     executeTaskAndWaitForResult(createBuildAllTask(folderContext)),
@@ -282,7 +294,11 @@ suite("DiagnosticsManager Test Suite", async function () {
 
                 await Promise.all([
                     waitForDiagnostics({
-                        [mainUri.fsPath]: [expectedWarningDiagnostic, expectedMainErrorDiagnostic], // Should have parsed correct severity
+                        [mainUri.fsPath]: [
+                            expectedWarningDiagnostic,
+                            expectedMainErrorDiagnostic,
+                            expectedMainDictErrorDiagnostic,
+                        ], // Should have parsed correct severity
                         [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
                     }),
                     executeTaskAndWaitForResult(createBuildAllTask(folderContext)),
@@ -365,9 +381,22 @@ suite("DiagnosticsManager Test Suite", async function () {
                 );
                 expectedDiagnostic2.source = "swiftc";
 
+                // Message should not contain [-Wreturn-mismatch] so it can be merged with
+                // SourceKit diagnostics if required
+                const expectedDiagnostic3 = new vscode.Diagnostic(
+                    new vscode.Range(new vscode.Position(11, 4), new vscode.Position(11, 4)),
+                    "Non-void function 'main' should return a value",
+                    vscode.DiagnosticSeverity.Error
+                );
+                expectedDiagnostic3.source = "swiftc";
+
                 await Promise.all([
                     waitForDiagnostics({
-                        [cppUri.fsPath]: [expectedDiagnostic1, expectedDiagnostic2],
+                        [cppUri.fsPath]: [
+                            expectedDiagnostic1,
+                            expectedDiagnostic2,
+                            expectedDiagnostic3,
+                        ],
                     }),
                     executeTaskAndWaitForResult(createBuildAllTask(cppFolderContext)),
                 ]);