Merge pull request #1852 from matthewbastien/document-symbols

Include parameters in initializer document symbols

Author: matthewbastien

Sources/SourceKitLSP/Swift/DocumentSymbols.swift

@@ -247,7 +247,7 @@ fileprivate final class DocumentSymbolsFinder: SyntaxAnyVisitor {
   override func visit(_ node: InitializerDeclSyntax) -> SyntaxVisitorContinueKind {
     return record(
       node: node,
-      name: node.initKeyword.text,
+      name: node.declName,
       symbolKind: .constructor,
       range: node.rangeWithoutTrivia,
       selection: node.initKeyword
@@ -304,6 +304,18 @@ fileprivate extension FunctionDeclSyntax {
   }
 }
 
+fileprivate extension InitializerDeclSyntax {
+  var declName: String {
+    var result = self.initKeyword.text
+    result += "("
+    for parameter in self.signature.parameterClause.parameters {
+      result += "\(parameter.firstName.text):"
+    }
+    result += ")"
+    return result
+  }
+}
+
 fileprivate extension SyntaxProtocol {
   /// The position range of this node without its leading and trailing trivia.
   var rangeWithoutTrivia: Range<AbsolutePosition> {

Tests/SourceKitLSPTests/DocumentSymbolTests.swift

@@ -552,7 +552,39 @@ final class DocumentSymbolTests: XCTestCase {
           selectionRange: positions["2️⃣"]..<positions["3️⃣"],
           children: [
             DocumentSymbol(
-              name: "init",
+              name: "init()",
+              detail: nil,
+              kind: .constructor,
+              deprecated: nil,
+              range: positions["4️⃣"]..<positions["6️⃣"],
+              selectionRange: positions["4️⃣"]..<positions["5️⃣"],
+              children: []
+            )
+          ]
+        )
+      ]
+    }
+  }
+
+  func testInitializerWithParameters() async throws {
+    try await assertDocumentSymbols(
+      """
+      1️⃣class 2️⃣Foo3️⃣ {
+        4️⃣init(_ first: Int, second: Int)5️⃣ { }6️⃣
+      }7️⃣
+      """
+    ) { positions in
+      [
+        DocumentSymbol(
+          name: "Foo",
+          detail: nil,
+          kind: .class,
+          deprecated: nil,
+          range: positions["1️⃣"]..<positions["7️⃣"],
+          selectionRange: positions["2️⃣"]..<positions["3️⃣"],
+          children: [
+            DocumentSymbol(
+              name: "init(_:second:)",
               detail: nil,
               kind: .constructor,
               deprecated: nil,