review updates

ocaml · Nov 6, 2024 · fd7e6fa · fd7e6fa
1 parent 6100599
commit fd7e6fa
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 16 deletions.
diff --git a/ocaml-lsp-server/docs/ocamllsp/typeSearch-spec.md b/ocaml-lsp-server/docs/ocamllsp/typeSearch-spec.md
@@ -17,6 +17,7 @@ export interface TypeSearchParams extends TexDocumentPositionParams
     query: string;
     limit: int;
     with_doc: bool;
+    doc_format: string;
 }
 ```
 - method: `ocamllsp/typeSearch`
@@ -36,7 +37,10 @@ export interface TypeSearchParams extends TexDocumentPositionParams
         "name": string,
         "typ": string,
         "loc": Range,
-        "doc": string,
+        "doc": {
+            "value": string,
+            "kind": string
+        },
         "cost": int,
         "constructible" : string
     ]

diff --git a/ocaml-lsp-server/src/custom_requests/req_type_search.ml b/ocaml-lsp-server/src/custom_requests/req_type_search.ml
@@ -37,19 +37,19 @@ module TypeSearchParams = struct
       | 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 ])
-       @ doc_format)
+      (("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 create ~kind ~value =
+  let doc_to_markupContent ~kind ~value =
     let v =
       match kind with
       | MarkupKind.Markdown ->
@@ -74,7 +74,8 @@ module TypeSearch = struct
         ; "loc", Range.yojson_of_t (Range.of_loc res.loc)
         ; ( "doc"
           , match res.doc with
-            | Some value -> create ~kind:format ~value |> MarkupContent.yojson_of_t
+            | Some value ->
+              doc_to_markupContent ~kind:format ~value |> MarkupContent.yojson_of_t
             | None -> `Null )
         ; "cost", `Int res.cost
         ; "constructible", `String res.constructible

diff --git a/ocaml-lsp-server/test/e2e-new/type_search.ml b/ocaml-lsp-server/test/e2e-new/type_search.ml
@@ -137,13 +137,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:false
-    ();
+  Util.test ~line ~character ~query:"int -> string" source ~with_doc:false ();
   [%expect
     {|
     [