Fix diagnostic parsing when spaces in file name (#1633)

* Fix diagnostic parsing when spaces in file name

Also found way to parse out *some* of the "swift" diagnostic style notes.
With that in mind, don't make "llvm" the default diagnostic style since
it causes friction when switching between building on the command line
and in vscode.

Issue: #1350 #1630

* Fix formatting issue

* Add changelog entry

* Ignore macro related information prior to 6.1

* Remove .only

Author: award999

CHANGELOG.md

@@ -14,6 +14,7 @@
 - Fix `Swift: Reset Package Dependencies` command on Windows ([#1614](https://github.com/swiftlang/vscode-swift/pull/1614))
 - Activate extension when a .swift source file exists in a subfolder ([#1635](https://github.com/swiftlang/vscode-swift/pull/1635))
 - Resolve Swiftly toolchain path ([#1632](https://github.com/swiftlang/vscode-swift/pull/1632))
+- Fix diagnostic parsing when the file has a space in it ([#1633](https://github.com/swiftlang/vscode-swift/pull/1633))
 - Hide files excluded with files.exclude from Project Panel ([#1626](https://github.com/swiftlang/vscode-swift/pull/1626))
 
 ## 2.4.0 - 2025-06-11

assets/test/defaultPackage/.vscode/launch copy.json

@@ -426,7 +426,7 @@
           },
           "swift.diagnosticsStyle": {
             "type": "string",
-            "default": "llvm",
+            "default": "default",
             "markdownDescription": "The formatting style used when printing diagnostics in the Problems panel. Corresponds to the `-diagnostic-style` option to pass to `swiftc` when running `swift` tasks.",
             "enum": [
               "default",

assets/test/diagnostics/Sources/func.swift renamed to assets/test/diagnostics/Sources/func in here.swift

@@ -391,7 +391,7 @@ 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]*)(.*?):(\d+)(?::(\d+))?:\s+(warning|error|note):\s+(.*)$/g;
         const switfcExtraWarningsRegex = /\[(-W|#).*?\]/g;
         const match = diagnosticRegex.exec(line);
         if (!match) {

package.json

@@ -383,7 +383,7 @@ const configuration = {
     get diagnosticsStyle(): DiagnosticStyle {
         return vscode.workspace
             .getConfiguration("swift")
-            .get<DiagnosticStyle>("diagnosticsStyle", "llvm");
+            .get<DiagnosticStyle>("diagnosticsStyle", "default");
     },
     /** where to show the build progress for the running task */
     get showBuildStatus(): ShowBuildStatusOptions {

src/DiagnosticsManager.ts

@@ -134,7 +134,7 @@ suite("DiagnosticsManager Test Suite", function () {
             cFolderContext = await folderInRootWorkspace("diagnosticsC", workspaceContext);
             cppFolderContext = await folderInRootWorkspace("diagnosticsCpp", workspaceContext);
             mainUri = testAssetUri("diagnostics/Sources/main.swift");
-            funcUri = testAssetUri("diagnostics/Sources/func.swift");
+            funcUri = testAssetUri("diagnostics/Sources/func in here.swift"); // Want spaces in name to watch https://github.com/swiftlang/vscode-swift/issues/1630
             cUri = testAssetUri("diagnosticsC/Sources/MyPoint/MyPoint.c");
             cppUri = testAssetUri("diagnosticsCpp/Sources/MyPoint/MyPoint.cpp");
             cppHeaderUri = testAssetUri("diagnosticsCpp/Sources/MyPoint/include/MyPoint.h");
@@ -271,19 +271,50 @@ suite("DiagnosticsManager Test Suite", function () {
                 });
             }
 
-            runTestDiagnosticStyle("default", () => ({
-                [mainUri.fsPath]: [
-                    expectedWarningDiagnostic,
-                    expectedMainErrorDiagnostic,
-                    expectedMainDictErrorDiagnostic,
-                    ...(workspaceContext.globalToolchainSwiftVersion.isGreaterThanOrEqual(
-                        new Version(6, 0, 0)
-                    )
-                        ? [expectedMacroDiagnostic]
-                        : []),
-                ], // Should have parsed correct severity
-                [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
-            }));
+            runTestDiagnosticStyle(
+                "default",
+                () => ({
+                    [mainUri.fsPath]: [
+                        expectedWarningDiagnostic,
+                        expectedMainErrorDiagnostic,
+                        expectedMainDictErrorDiagnostic,
+                        ...(workspaceContext.globalToolchainSwiftVersion.isGreaterThanOrEqual(
+                            new Version(6, 0, 0)
+                        )
+                            ? [expectedMacroDiagnostic]
+                            : []),
+                    ], // Should have parsed correct severity
+                    [funcUri.fsPath]: [expectedFuncErrorDiagnostic], // Check parsed for other file
+                }),
+                () => {
+                    test("Parses related information", async function () {
+                        if (
+                            workspaceContext.globalToolchainSwiftVersion.isLessThan(
+                                new Version(6, 1, 0)
+                            )
+                        ) {
+                            this.skip();
+                        }
+                        const diagnostic = assertHasDiagnostic(mainUri, expectedMacroDiagnostic);
+                        // Should have parsed related note
+                        assert.equal(diagnostic.relatedInformation?.length, 1);
+                        assert.equal(
+                            diagnostic.relatedInformation![0].message,
+                            "Expanded code originates here"
+                        );
+                        assert.equal(
+                            diagnostic.relatedInformation![0].location.uri.fsPath,
+                            mainUri.fsPath
+                        );
+                        assert.equal(
+                            diagnostic.relatedInformation![0].location.range.isEqual(
+                                expectedMacroDiagnostic.range
+                            ),
+                            true
+                        );
+                    });
+                }
+            );
 
             runTestDiagnosticStyle("swift", () => ({
                 [mainUri.fsPath]: [

src/configuration.ts

@@ -123,8 +123,6 @@ suite("WorkspaceContext Test Suite", () => {
             assert.strictEqual(buildAllTask.name, "Build All (defaultPackage)");
             assertContainsArg(execution, "build");
             assertContainsArg(execution, "--build-tests");
-            assertContainsArg(execution, "-Xswiftc");
-            assertContainsArg(execution, "-diagnostic-style=llvm");
             assert.strictEqual(buildAllTask.scope, resolveScope(folder.workspaceFolder));
         });
 

test/integration-tests/DiagnosticsManager.test.ts

@@ -101,9 +101,7 @@ suite("SwiftTaskProvider Test Suite", () => {
             });
 
             test("provided", async () => {
-                expect(task?.detail)
-                    .to.include("swift build --build-tests")
-                    .and.to.include("-Xswiftc -diagnostic-style=llvm");
+                expect(task?.detail).to.include("swift build --build-tests");
             });
 
             test("executes @slow", async () => {
@@ -144,9 +142,7 @@ suite("SwiftTaskProvider Test Suite", () => {
         test("includes product debug task", async () => {
             const tasks = await vscode.tasks.fetchTasks({ type: "swift" });
             const task = tasks.find(t => t.name === "Build Debug PackageExe (defaultPackage)");
-            expect(task?.detail)
-                .to.include("swift build --product PackageExe")
-                .and.to.include("-Xswiftc -diagnostic-style=llvm");
+            expect(task?.detail).to.include("swift build --product PackageExe");
         });
 
         test("includes product release task", async () => {