add doc format

Author: PizieDust

ocaml-lsp-server/src/custom_requests/req_type_search.ml

@@ -11,6 +11,7 @@ module TypeSearchParams = struct
     ; limit : int
     ; query : string
     ; with_doc : bool
+    ; doc_format : MarkupKind.t option
     }
 
   let t_of_yojson json =
@@ -19,36 +20,61 @@ module TypeSearchParams = struct
     let query = json |> member "query" |> to_string in
     let limit = json |> member "limit" |> to_int in
     let with_doc = json |> member "with_doc" |> to_bool in
+    let doc_format = json |> member "doc_format" |> to_option MarkupKind.t_of_yojson in
     { position = textDocumentPosition.position
     ; text_document = textDocumentPosition.textDocument
     ; query
     ; limit
     ; with_doc
+    ; doc_format
     }
   ;;
 
-  let yojson_of_t { text_document; position; query; limit; with_doc } =
+  let yojson_of_t { text_document; position; query; limit; with_doc; doc_format } =
+    let doc_format =
+      match doc_format with
+      | Some format -> [ "doc_format", MarkupKind.yojson_of_t format ]
+      | None -> []
+    in
     `Assoc
-      (("textDocument", TextDocumentIdentifier.yojson_of_t text_document)
-       :: ("position", Position.yojson_of_t position)
-       :: ("limit", `Int limit)
-       :: ("with_doc", `Bool with_doc)
-       :: [ "query", `String query ])
+      ((("textDocument", TextDocumentIdentifier.yojson_of_t text_document)
+        :: ("position", Position.yojson_of_t position)
+        :: ("limit", `Int limit)
+        :: ("with_doc", `Bool with_doc)
+        :: [ "query", `String query ])
+       @ doc_format)
   ;;
 end
 
 module TypeSearch = struct
   type t = string Query_protocol.type_search_result list
 
-  let yojson_of_t (t : t) =
+  let create ~kind ~value =
+    let v =
+      match kind with
+      | MarkupKind.Markdown ->
+        (match Doc_to_md.translate value with
+         | Raw d -> d
+         | Markdown d -> d)
+      | MarkupKind.PlainText -> value
+    in
+    MarkupContent.create ~kind ~value:v
+  ;;
+
+  let yojson_of_t (t : t) doc_format =
+    let format =
+      match doc_format with
+      | Some format -> format
+      | None -> MarkupKind.PlainText
+    in
     let yojson_of_type_search_result (res : string Query_protocol.type_search_result) =
       `Assoc
         [ "name", `String res.name
         ; "typ", `String res.typ
         ; "loc", Range.yojson_of_t (Range.of_loc res.loc)
         ; ( "doc"
           , match res.doc with
-            | Some d -> `String d
+            | Some value -> create ~kind:format ~value |> MarkupContent.yojson_of_t
             | None -> `Null )
         ; "cost", `Int res.cost
         ; "constructible", `String res.constructible
@@ -65,28 +91,28 @@ module Request_params = struct
 
   let yojson_of_t t = TypeSearchParams.yojson_of_t t
 
-  let create text_document position limit query with_doc : t =
-    { text_document; position; limit; query; with_doc }
+  let create text_document position limit query with_doc doc_format : t =
+    { text_document; position; limit; query; with_doc; doc_format }
   ;;
 end
 
-let dispatch merlin position limit query with_doc =
+let dispatch merlin position limit query with_doc doc_format =
   Document.Merlin.with_pipeline_exn merlin (fun pipeline ->
     let position = Position.logical position in
     let query = Query_protocol.Type_search (query, position, limit, with_doc) in
     let results = Query_commands.dispatch pipeline query in
-    TypeSearch.yojson_of_t results)
+    TypeSearch.yojson_of_t results doc_format)
 ;;
 
 let on_request ~params state =
   Fiber.of_thunk (fun () ->
     let params = (Option.value ~default:(`Assoc []) params :> Yojson.Safe.t) in
-    let TypeSearchParams.{ text_document; position; limit; query; with_doc } =
+    let TypeSearchParams.{ text_document; position; limit; query; with_doc; doc_format } =
       TypeSearchParams.t_of_yojson params
     in
     let uri = text_document.uri in
     let doc = Document_store.get state.State.store uri in
     match Document.kind doc with
     | `Other -> Fiber.return `Null
-    | `Merlin merlin -> dispatch merlin position limit query with_doc)
+    | `Merlin merlin -> dispatch merlin position limit query with_doc doc_format)
 ;;

ocaml-lsp-server/src/custom_requests/req_type_search.mli

@@ -4,7 +4,15 @@ module Request_params : sig
   type t
 
   val yojson_of_t : t -> Json.t
-  val create : TextDocumentIdentifier.t -> Position.t -> int -> string -> bool -> t
+
+  val create
+    :  TextDocumentIdentifier.t
+    -> Position.t
+    -> int
+    -> string
+    -> bool
+    -> MarkupKind.t option
+    -> t
 end
 
 type t

ocaml-lsp-server/test/e2e-new/type_search.ml

@@ -2,11 +2,11 @@ open Test.Import
 module Req = Ocaml_lsp_server.Custom_request.Type_search
 
 module Util = struct
-  let call_search position query with_doc client =
+  let call_search position query with_doc doc_format client =
     let uri = DocumentUri.of_path "test.ml" in
     let text_document = TextDocumentIdentifier.create ~uri in
     let params =
-      Req.Request_params.create text_document position 3 query with_doc
+      Req.Request_params.create text_document position 3 query with_doc doc_format
       |> Req.Request_params.yojson_of_t
       |> Jsonrpc.Structured.t_of_yojson
       |> Option.some
@@ -17,11 +17,11 @@ module Util = struct
     Client.request client req
   ;;
 
-  let test ~line ~character ~query source ~with_doc =
+  let test ~line ~character ~query source ~with_doc ?(doc_format = None) () =
     let position = Position.create ~character ~line in
     let request client =
       let open Fiber.O in
-      let+ response = call_search position query with_doc client in
+      let+ response = call_search position query with_doc doc_format client in
       Test.print_result response
     in
     Helpers.test source request
@@ -34,7 +34,8 @@ let%expect_test "Polarity Search for a simple query that takes an int and return
   let source = "" in
   let line = 1 in
   let character = 0 in
-  Util.test ~line ~character ~query:"-int +string" source ~with_doc:true;
+  let doc_format = Some MarkupKind.Markdown in
+  Util.test ~line ~character ~query:"-int +string" source ~with_doc:true ~doc_format ();
   [%expect
     {|
     [
@@ -45,7 +46,10 @@ let%expect_test "Polarity Search for a simple query that takes an int and return
           "end": { "character": 29, "line": 152 },
           "start": { "character": 0, "line": 152 }
         },
-        "doc": "[to_string x] is the written representation of [x] in decimal.",
+        "doc": {
+          "kind": "markdown",
+          "value": "`to_string x` is the written representation of `x` in decimal."
+        },
         "cost": 4,
         "constructible": "Int.to_string _"
       },
@@ -56,7 +60,10 @@ let%expect_test "Polarity Search for a simple query that takes an int and return
           "end": { "character": 33, "line": 740 },
           "start": { "character": 0, "line": 740 }
         },
-        "doc": "Return the string representation of an integer, in decimal.",
+        "doc": {
+          "kind": "markdown",
+          "value": "Return the string representation of an integer, in decimal."
+        },
         "cost": 4,
         "constructible": "string_of_int _"
       },
@@ -67,11 +74,15 @@ let%expect_test "Polarity Search for a simple query that takes an int and return
           "end": { "character": 33, "line": 740 },
           "start": { "character": 0, "line": 740 }
         },
-        "doc": "Return the string representation of an integer, in decimal.",
+        "doc": {
+          "kind": "markdown",
+          "value": "Return the string representation of an integer, in decimal."
+        },
         "cost": 4,
         "constructible": "string_of_int _"
       }
-    ] |}]
+    ]
+    |}]
 ;;
 
 let%expect_test "Polarity Search for a simple query that takes an int and returns a \
@@ -80,7 +91,7 @@ let%expect_test "Polarity Search for a simple query that takes an int and return
   let source = "" in
   let line = 1 in
   let character = 0 in
-  Util.test ~line ~character ~query:"-int +string" source ~with_doc:false;
+  Util.test ~line ~character ~query:"-int +string" source ~with_doc:false ();
   [%expect
     {|
     [
@@ -126,7 +137,13 @@ let%expect_test "Type Search for a simple query that takes an int and returns a
   let source = "" in
   let line = 1 in
   let character = 0 in
-  Util.test ~line ~character ~query:"int -> string" source ~with_doc:false;
+  Util.test
+    ~line
+    ~character
+    ~query:"int -> string"
+    source
+    ~with_doc:false
+    ();
   [%expect
     {|
     [
@@ -172,7 +189,7 @@ let%expect_test "Type Search for a simple query that takes an int and returns a
   let source = "" in
   let line = 1 in
   let character = 0 in
-  Util.test ~line ~character ~query:"int -> string" source ~with_doc:true;
+  Util.test ~line ~character ~query:"int -> string" source ~with_doc:true ();
   [%expect
     {|
     [
@@ -183,7 +200,10 @@ let%expect_test "Type Search for a simple query that takes an int and returns a
           "end": { "character": 29, "line": 152 },
           "start": { "character": 0, "line": 152 }
         },
-        "doc": "[to_string x] is the written representation of [x] in decimal.",
+        "doc": {
+          "kind": "plaintext",
+          "value": "[to_string x] is the written representation of [x] in decimal."
+        },
         "cost": 0,
         "constructible": "Int.to_string _"
       },
@@ -194,7 +214,10 @@ let%expect_test "Type Search for a simple query that takes an int and returns a
           "end": { "character": 33, "line": 740 },
           "start": { "character": 0, "line": 740 }
         },
-        "doc": "Return the string representation of an integer, in decimal.",
+        "doc": {
+          "kind": "plaintext",
+          "value": "Return the string representation of an integer, in decimal."
+        },
         "cost": 0,
         "constructible": "string_of_int _"
       },
@@ -205,9 +228,13 @@ let%expect_test "Type Search for a simple query that takes an int and returns a
           "end": { "character": 33, "line": 740 },
           "start": { "character": 0, "line": 740 }
         },
-        "doc": "Return the string representation of an integer, in decimal.",
+        "doc": {
+          "kind": "plaintext",
+          "value": "Return the string representation of an integer, in decimal."
+        },
         "cost": 0,
         "constructible": "string_of_int _"
       }
-    ] |}]
+    ]
+    |}]
 ;;