Merge pull request #1960 from matthewbastien/improved-codelens

Add target display name to run and debug code lenses

Author: matthewbastien

Sources/SourceKitLSP/Swift/SwiftCodeLensScanner.swift

@@ -21,11 +21,18 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
   /// The collection of CodeLenses found in the document.
   private var result: [CodeLens] = []
 
+  private let targetName: String?
+
   /// The map of supported commands and their client side command names
   private let supportedCommands: [SupportedCodeLensCommand: String]
 
-  private init(snapshot: DocumentSnapshot, supportedCommands: [SupportedCodeLensCommand: String]) {
+  private init(
+    snapshot: DocumentSnapshot,
+    targetName: String?,
+    supportedCommands: [SupportedCodeLensCommand: String]
+  ) {
     self.snapshot = snapshot
+    self.targetName = targetName
     self.supportedCommands = supportedCommands
     super.init(viewMode: .fixedUp)
   }
@@ -35,6 +42,7 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
   public static func findCodeLenses(
     in snapshot: DocumentSnapshot,
     syntaxTreeManager: SyntaxTreeManager,
+    targetName: String? = nil,
     supportedCommands: [SupportedCodeLensCommand: String]
   ) async -> [CodeLens] {
     guard snapshot.text.contains("@main") && !supportedCommands.isEmpty else {
@@ -43,7 +51,7 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
     }
 
     let syntaxTree = await syntaxTreeManager.syntaxTree(for: snapshot)
-    let visitor = SwiftCodeLensScanner(snapshot: snapshot, supportedCommands: supportedCommands)
+    let visitor = SwiftCodeLensScanner(snapshot: snapshot, targetName: targetName, supportedCommands: supportedCommands)
     visitor.walk(syntaxTree)
     return visitor.result
   }
@@ -61,14 +69,20 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
   private func captureLensFromAttribute(attribute: AttributeListSyntax.Element) {
     if attribute.trimmedDescription == "@main" {
       let range = self.snapshot.absolutePositionRange(of: attribute.trimmedRange)
+      var targetNameToAppend: String = ""
+      var arguments: [LSPAny] = []
+      if let targetName {
+        targetNameToAppend = " \(targetName)"
+        arguments.append(.string(targetName))
+      }
 
       if let runCommand = supportedCommands[SupportedCodeLensCommand.run] {
         // Return commands for running/debugging the executable.
         // These command names must be recognized by the client and so should not be chosen arbitrarily.
         self.result.append(
           CodeLens(
             range: range,
-            command: Command(title: "Run", command: runCommand, arguments: nil)
+            command: Command(title: "Run" + targetNameToAppend, command: runCommand, arguments: arguments)
           )
         )
       }
@@ -77,7 +91,7 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
         self.result.append(
           CodeLens(
             range: range,
-            command: Command(title: "Debug", command: debugCommand, arguments: nil)
+            command: Command(title: "Debug" + targetNameToAppend, command: debugCommand, arguments: arguments)
           )
         )
       }

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -12,6 +12,7 @@
 
 #if compiler(>=6)
 package import BuildSystemIntegration
+import BuildServerProtocol
 import Csourcekitd
 import Dispatch
 import Foundation
@@ -30,6 +31,7 @@ package import SwiftSyntax
 package import ToolchainRegistry
 #else
 import BuildSystemIntegration
+import BuildServerProtocol
 import Csourcekitd
 import Dispatch
 import Foundation
@@ -1051,9 +1053,17 @@ extension SwiftLanguageService {
 
   package func codeLens(_ req: CodeLensRequest) async throws -> [CodeLens] {
     let snapshot = try documentManager.latestSnapshot(req.textDocument.uri)
+    var targetDisplayName: String? = nil
+    if let workspace = await sourceKitLSPServer?.workspaceForDocument(uri: req.textDocument.uri),
+      let target = await workspace.buildSystemManager.canonicalTarget(for: req.textDocument.uri),
+      let buildTarget = await workspace.buildSystemManager.buildTarget(named: target)
+    {
+      targetDisplayName = buildTarget.displayName
+    }
     return await SwiftCodeLensScanner.findCodeLenses(
       in: snapshot,
       syntaxTreeManager: self.syntaxTreeManager,
+      targetName: targetDisplayName,
       supportedCommands: self.capabilityRegistry.supportedCodeLensCommands
     )
   }

Tests/SourceKitLSPTests/CodeLensTests.swift

@@ -73,13 +73,23 @@ final class CodeLensTests: XCTestCase {
 
     let project = try await SwiftPMTestProject(
       files: [
-        "Test.swift": """
+        "Sources/MyApp/Test.swift": """
         1️⃣@main2️⃣
         struct MyApp {
           public static func main() {}
         }
         """
       ],
+      manifest: """
+        // swift-tools-version: 5.7
+
+        import PackageDescription
+
+        let package = Package(
+          name: "MyApp",
+          targets: [.executableTarget(name: "MyApp")]
+        )
+        """,
       capabilities: capabilities
     )
 
@@ -94,11 +104,11 @@ final class CodeLensTests: XCTestCase {
       [
         CodeLens(
           range: positions["1️⃣"]..<positions["2️⃣"],
-          command: Command(title: "Run", command: "swift.run", arguments: nil)
+          command: Command(title: "Run MyApp", command: "swift.run", arguments: [.string("MyApp")])
         ),
         CodeLens(
           range: positions["1️⃣"]..<positions["2️⃣"],
-          command: Command(title: "Debug", command: "swift.debug", arguments: nil)
+          command: Command(title: "Debug MyApp", command: "swift.debug", arguments: [.string("MyApp")])
         ),
       ]
     )