Enumerate supported code lens commands

Author: plemarquand

Sources/LanguageServerProtocol/SupportTypes/ClientCapabilities.swift

@@ -470,9 +470,15 @@ public struct TextDocumentClientCapabilities: Hashable, Codable, Sendable {
     /// Whether the client supports dynamic registration of this request.
     public var dynamicRegistration: Bool?
 
-    public var supportedCommands: [String: String]
+    /// Dictionary of supported commands announced by the client.
+    /// The key is the CodeLens name recognized by SourceKit-LSP and the
+    /// value is the command as recognized by the client.
+    public var supportedCommands: [SupportedCodeLensCommand: String]
 
-    public init(dynamicRegistration: Bool? = nil, supportedCommands: [String: String] = [:]) {
+    public init(
+      dynamicRegistration: Bool? = nil,
+      supportedCommands: [SupportedCodeLensCommand: String] = [:]
+    ) {
       self.dynamicRegistration = dynamicRegistration
       self.supportedCommands = supportedCommands
     }

Sources/LanguageServerProtocol/SupportTypes/SupportedCodeLensCommand.swift

@@ -0,0 +1,20 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+/// Code lenses that LSP can annotate code with.
+///
+/// Clients provide these as keys to the `supportedCommands` dictionary supplied
+/// in the client's `InitializeRequest`.
+public enum SupportedCodeLensCommand: String, Sendable {
+  case run = "swift.run"
+  case debug = "swift.debug"
+}

Sources/SourceKitLSP/CapabilityRegistry.swift

@@ -38,9 +38,6 @@ public final actor CapabilityRegistry {
   /// Dynamically registered pull diagnostics options.
   private var pullDiagnostics: [CapabilityRegistration: DiagnosticRegistrationOptions] = [:]
 
-  /// Dynamically registered code lens options.
-  private var codeLens: [CapabilityRegistration: CodeLensRegistrationOptions] = [:]
-
   /// Dynamically registered file watchers.
   private var didChangeWatchedFiles: DidChangeWatchedFilesRegistrationOptions?
 
@@ -83,7 +80,7 @@ public final actor CapabilityRegistry {
     clientCapabilities.textDocument?.publishDiagnostics?.codeDescriptionSupport == true
   }
 
-  public var supportedCodeLensCommands: [String: String] {
+  public var supportedCodeLensCommands: [SupportedCodeLensCommand: String] {
     clientCapabilities.textDocument?.codeLens?.supportedCommands ?? [:]
   }
 

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -980,14 +980,18 @@ extension SourceKitLSPServer {
         case let .dictionary(codeLensConfig) = codeLens,
         case let .dictionary(supportedCommands) = codeLensConfig["supportedCommands"]
       {
-        let commandMap = supportedCommands.compactMapValues({
-          if case let .string(val) = $0 {
-            return val
+        let commandMap = supportedCommands.compactMap { (key, value) in
+          if case let .string(clientCommand) = value,
+            let lspCommand = SupportedCodeLensCommand(rawValue: key)
+          {
+            return (lspCommand, clientCommand)
           }
+
+          logger.error("Encountered an unsupported code lens \"\(key)\" in client's initialization request.")
           return nil
-        })
+        }
 
-        clientCapabilities.textDocument?.codeLens?.supportedCommands = commandMap
+        clientCapabilities.textDocument?.codeLens?.supportedCommands = Dictionary(uniqueKeysWithValues: commandMap)
       }
     }
 

Sources/SourceKitLSP/Swift/SwiftCodeLensScanner.swift

@@ -22,9 +22,9 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
   private var result: [CodeLens] = []
 
   /// The map of supported commands and their client side command names
-  private let supportedCommands: [String: String]
+  private let supportedCommands: [SupportedCodeLensCommand: String]
 
-  private init(snapshot: DocumentSnapshot, supportedCommands: [String: String]) {
+  private init(snapshot: DocumentSnapshot, supportedCommands: [SupportedCodeLensCommand: String]) {
     self.snapshot = snapshot
     self.supportedCommands = supportedCommands
     super.init(viewMode: .fixedUp)
@@ -35,7 +35,7 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
   public static func findCodeLenses(
     in snapshot: DocumentSnapshot,
     syntaxTreeManager: SyntaxTreeManager,
-    supportedCommands: [String: String]
+    supportedCommands: [SupportedCodeLensCommand: String]
   ) async -> [CodeLens] {
     guard snapshot.text.contains("@main") && !supportedCommands.isEmpty else {
       // This is intended to filter out files that obviously do not contain an entry point.
@@ -62,7 +62,7 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
     if attribute.trimmedDescription == "@main" {
       let range = self.snapshot.absolutePositionRange(of: attribute.trimmedRange)
 
-      if let runCommand = supportedCommands["swift.run"] {
+      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(
@@ -73,7 +73,7 @@ final class SwiftCodeLensScanner: SyntaxVisitor {
         )
       }
 
-      if let debugCommand = supportedCommands["swift.debug"] {
+      if let debugCommand = supportedCommands[SupportedCodeLensCommand.run] {
         self.result.append(
           CodeLens(
             range: range,

Tests/SourceKitLSPTests/CodeLensTests.swift

@@ -19,8 +19,8 @@ final class CodeLensTests: XCTestCase {
   func testNoLenses() async throws {
     var codeLensCapabilities = TextDocumentClientCapabilities.CodeLens()
     codeLensCapabilities.supportedCommands = [
-      "swift.run": "swift.run",
-      "swift.debug": "swift.debug"
+      SupportedCodeLensCommand.run: "swift.run",
+      SupportedCodeLensCommand.debug: "swift.debug"
     ]
     let capabilities = ClientCapabilities(textDocument: TextDocumentClientCapabilities(codeLens: codeLensCapabilities))
 
@@ -67,8 +67,8 @@ final class CodeLensTests: XCTestCase {
   func testSuccessfulCodeLensRequest() async throws {
     var codeLensCapabilities = TextDocumentClientCapabilities.CodeLens()
     codeLensCapabilities.supportedCommands = [
-      "swift.run": "swift.run",
-      "swift.debug": "swift.debug"
+      SupportedCodeLensCommand.run: "swift.run",
+      SupportedCodeLensCommand.debug: "swift.debug"
     ]
     let capabilities = ClientCapabilities(textDocument: TextDocumentClientCapabilities(codeLens: codeLensCapabilities))