rename request to textDocument/doccDocumentation

Author: matthewbastien

Contributor Documentation/LSP Extensions.md

@@ -169,7 +169,7 @@ interface SKCompletionOptions {
 }
 ```
 
-## `textDocument/convertDocumentation`
+## `textDocument/doccDocumentation`
 
 New request that returns a RenderNode for a symbol at a given location that can then be
 rendered in an editor by `swiftlang/swift-docc-render`.
@@ -180,11 +180,11 @@ or an error if the documentation could not be converted. This error message can
 to the user in the live preview editor.
 
 At the moment this request is only available on macOS and Linux. If SourceKit-LSP supports
-this request it will add `textDocument/convertDocumentation` to its experimental server
+this request it will add `textDocument/doccDocumentation` to its experimental server
 capabilities.
 
 ```ts
-export interface ConvertDocumentationParams {
+export interface DoccDocumentationParams {
     /**
      * The document to render documentation for.
      */
@@ -199,7 +199,7 @@ export interface ConvertDocumentationParams {
     position: Position;
 }
 
-export type ConvertDocumentationResponse = RenderNodeResponse | ErrorResponse;
+export type DoccDocumentationResponse = RenderNodeResponse | ErrorResponse;
 
 interface RenderNodeResponse {
   /**
@@ -222,10 +222,10 @@ interface ErrorResponse {
   /**
    * The error that occurred.
    */
-  error: ConvertDocumentationError;
+  error: DoccDocumentationError;
 }
 
-export type ConvertDocumentationError = ErrorWithNoParams | SymbolNotFoundError;
+export type DoccDocumentationError = ErrorWithNoParams | SymbolNotFoundError;
 
 interface ErrorWithNoParams {
   /**

Sources/LanguageServerProtocol/CMakeLists.txt

@@ -38,11 +38,11 @@ add_library(LanguageServerProtocol STATIC
   Requests/ColorPresentationRequest.swift
   Requests/CompletionItemResolveRequest.swift
   Requests/CompletionRequest.swift
-  Requests/ConvertDocumentationRequest.swift
   Requests/CreateWorkDoneProgressRequest.swift
   Requests/DeclarationRequest.swift
   Requests/DefinitionRequest.swift
   Requests/DiagnosticsRefreshRequest.swift
+  Requests/DoccDocumentationRequest.swift
   Requests/DocumentColorRequest.swift
   Requests/DocumentDiagnosticsRequest.swift
   Requests/DocumentHighlightRequest.swift

Sources/LanguageServerProtocol/Messages.swift

@@ -33,6 +33,7 @@ public let builtinRequests: [_RequestType.Type] = [
   DeclarationRequest.self,
   DefinitionRequest.self,
   DiagnosticsRefreshRequest.self,
+  DoccDocumentationRequest.self,
   DocumentColorRequest.self,
   DocumentDiagnosticsRequest.self,
   DocumentFormattingRequest.self,
@@ -70,7 +71,6 @@ public let builtinRequests: [_RequestType.Type] = [
   ShowMessageRequest.self,
   ShutdownRequest.self,
   SignatureHelpRequest.self,
-  ConvertDocumentationRequest.self,
   SymbolInfoRequest.self,
   TriggerReindexRequest.self,
   TypeDefinitionRequest.self,

Sources/LanguageServerProtocol/Requests/ConvertDocumentationRequest.swift renamed to Sources/LanguageServerProtocol/Requests/DoccDocumentationRequest.swift

@@ -10,46 +10,46 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// Request for converting documentation for the symbol at a given location **(LSP Extension)**.
+/// Request for generating documentation for the symbol at a given location **(LSP Extension)**.
 ///
 /// This request looks up the symbol (if any) at a given text document location and returns a
-/// ``ConvertDocumentationResponse`` for that location. This request is primarily designed for editors
+/// ``DoccDocumentationResponse`` for that location. This request is primarily designed for editors
 /// to support live preview of Swift documentation.
 ///
 /// - Parameters:
 ///   - textDocument: The document to render documentation for.
-///   - position: The document location at which to lookup symbol information.
+///   - position: The document location at which to lookup symbol information. (optional)
 ///
-/// - Returns: A ``ConvertDocumentationResponse`` for the given location, which may contain an error
+/// - Returns: A ``DoccDocumentationResponse`` for the given location, which may contain an error
 ///   message if documentation could not be converted. This error message can be displayed to the user
 ///   in the live preview editor.
 ///
 /// ### LSP Extension
 ///
 /// This request is an extension to LSP supported by SourceKit-LSP.
 /// The client is expected to display the documentation in an editor using swift-docc-render.
-public struct ConvertDocumentationRequest: TextDocumentRequest, Hashable {
-  public static let method: String = "textDocument/convertDocumentation"
-  public typealias Response = ConvertDocumentationResponse
+public struct DoccDocumentationRequest: TextDocumentRequest, Hashable {
+  public static let method: String = "textDocument/doccDocumentation"
+  public typealias Response = DoccDocumentationResponse
 
   /// The document in which to lookup the symbol location.
   public var textDocument: TextDocumentIdentifier
 
   /// The document location at which to lookup symbol information.
-  public var position: Position
+  public var position: Position?
 
-  public init(textDocument: TextDocumentIdentifier, position: Position) {
+  public init(textDocument: TextDocumentIdentifier, position: Position?) {
     self.textDocument = textDocument
     self.position = position
   }
 }
 
-public enum ConvertDocumentationResponse: ResponseType {
+public enum DoccDocumentationResponse: ResponseType {
   case renderNode(String)
-  case error(ConvertDocumentationError)
+  case error(DoccDocumentationError)
 }
 
-public enum ConvertDocumentationError: ResponseType, Equatable {
+public enum DoccDocumentationError: ResponseType, Equatable {
   case indexNotAvailable
   case noDocumentation
   case symbolNotFound(String)
@@ -66,7 +66,7 @@ public enum ConvertDocumentationError: ResponseType, Equatable {
   }
 }
 
-extension ConvertDocumentationError: Codable {
+extension DoccDocumentationError: Codable {
   enum CodingKeys: String, CodingKey {
     case kind
     case message
@@ -108,7 +108,7 @@ extension ConvertDocumentationError: Codable {
   }
 }
 
-extension ConvertDocumentationResponse: Codable {
+extension DoccDocumentationResponse: Codable {
   enum CodingKeys: String, CodingKey {
     case type
     case renderNode
@@ -123,7 +123,7 @@ extension ConvertDocumentationResponse: Codable {
       let renderNode = try values.decode(String.self, forKey: .renderNode)
       self = .renderNode(renderNode)
     case "error":
-      let error = try values.decode(ConvertDocumentationError.self, forKey: .error)
+      let error = try values.decode(DoccDocumentationError.self, forKey: .error)
       self = .error(error)
     default:
       throw DecodingError.dataCorruptedError(

Sources/SourceKitLSP/Documentation/DocumentationManager.swift

@@ -33,8 +33,9 @@ package final actor DocumentationManager {
 
   func convertDocumentation(
     _ documentURI: DocumentURI,
-    at position: Position = Position(line: 0, utf16index: 0)
-  ) async throws -> ConvertDocumentationResponse {
+    at position: Position? = nil
+  ) async throws -> DoccDocumentationResponse {
+    let position = position ?? Position(line: 0, utf16index: 0)
     guard let sourceKitLSPServer = sourceKitLSPServer else {
       throw ResponseError.internalError("SourceKit-LSP is shutting down")
     }

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -791,7 +791,7 @@ extension SourceKitLSPServer: QueueBasedMessageHandler {
     case let request as RequestAndReply<ShutdownRequest>:
       await request.reply { try await shutdown(request.params) }
     #if canImport(SwiftDocC)
-    case let request as RequestAndReply<ConvertDocumentationRequest>:
+    case let request as RequestAndReply<DoccDocumentationRequest>:
       await request.reply {
         try await documentationManager.convertDocumentation(
           request.params.textDocument.uri,
@@ -1056,7 +1056,7 @@ extension SourceKitLSPServer {
       "workspace/getReferenceDocument": .dictionary(["version": .int(1)]),
     ]
     #if canImport(SwiftDocC)
-    experimentalCapabilities["textDocument/convertDocumentation"] = .dictionary(["version": .int(1)])
+    experimentalCapabilities["textDocument/doccDocumentation"] = .dictionary(["version": .int(1)])
     #endif
 
     return ServerCapabilities(