Merge pull request #2086 from ahoppen/generated-interface-diags

Don’t return diagnostics for generated interfaces

Author: ahoppen

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -1058,6 +1058,13 @@ extension SwiftLanguageService {
 
   package func documentDiagnostic(_ req: DocumentDiagnosticsRequest) async throws -> DocumentDiagnosticReport {
     do {
+      switch try? ReferenceDocumentURL(from: req.textDocument.uri) {
+      case .generatedInterface:
+        // Generated interfaces don't have diagnostics associated with them.
+        return .full(RelatedFullDocumentDiagnosticReport(items: []))
+      case .macroExpansion, nil: break
+      }
+
       await semanticIndexManager?.prepareFileForEditorFunctionality(
         req.textDocument.uri.buildSettingsFile
       )

Tests/SourceKitLSPTests/SwiftInterfaceTests.swift

@@ -288,6 +288,37 @@ final class SwiftInterfaceTests: XCTestCase {
       linePrefix: "@inlinable public func filter(_ isIncluded: (Element) throws -> Bool) rethrows -> [Element]"
     )
   }
+
+  func testNoDiagnosticsInGeneratedInterface() async throws {
+    let testClient = try await TestSourceKitLSPClient(
+      capabilities: ClientCapabilities(experimental: [
+        "workspace/getReferenceDocument": .bool(true)
+      ])
+    )
+    let uri = DocumentURI(for: .swift)
+
+    let positions = testClient.openDocument(
+      """
+      func test(x: 1️⃣String) {}
+      """,
+      uri: uri
+    )
+
+    let definition = try await testClient.send(
+      DefinitionRequest(textDocument: TextDocumentIdentifier(uri), position: positions["1️⃣"])
+    )
+    let interfaceUri = try XCTUnwrap(definition?.locations?.only?.uri)
+    let interfaceContents = try await testClient.send(GetReferenceDocumentRequest(uri: interfaceUri))
+    testClient.send(
+      DidOpenTextDocumentNotification(
+        textDocument: TextDocumentItem(uri: interfaceUri, language: .swift, version: 0, text: interfaceContents.content)
+      )
+    )
+    let diagnostics = try await testClient.send(
+      DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(interfaceUri))
+    )
+    XCTAssertEqual(diagnostics.fullReport?.items, [])
+  }
 }
 
 private func assertSystemSwiftInterface(