Remove extra newline from passing a documentation with empty string

Author: chenglou

analysis/src/NewCompletions.ml

@@ -410,7 +410,7 @@ let getItems ~full ~package ~rawOpens ~allModules ~pos ~parts =
             (opens |> List.map (fun env -> attributeCompletions ~env ~suffix))))
 
 let mkItem ~name ~kind ~detail ~deprecated ~docstring =
-  let valueMessage =
+  let docContent =
     (match deprecated with None -> "" | Some s -> "Deprecated: " ^ s ^ "\n\n")
     ^
     match docstring with [] -> "" | _ :: _ -> docstring |> String.concat "\n"
@@ -424,7 +424,9 @@ let mkItem ~name ~kind ~detail ~deprecated ~docstring =
       kind;
       tags;
       detail;
-      documentation = {kind = "markdown"; value = valueMessage};
+      documentation =
+        (if docContent = "" then None
+        else Some {kind = "markdown"; value = docContent});
     }
 
 let processCompletable ~findItems ~package ~rawOpens

analysis/src/Protocol.ml

@@ -1,5 +1,3 @@
-let array l = "[" ^ (String.concat ", " l) ^ "]"
-
 type position = {
   line: int;
   character: int;
@@ -20,7 +18,7 @@ type completionItem = {
   kind: int;
   tags: int list;
   detail: string;
-  documentation: markupContent;
+  documentation: markupContent option;
 }
 
 type hover = {
@@ -32,6 +30,10 @@ type location = {
   range: range;
 }
 
+let null = "null"
+
+let array l = "[" ^ (String.concat ", " l) ^ "]"
+
 let stringifyPosition p =
    Printf.sprintf {|{"line": %i, "character": %i}|} p.line p.character
 
@@ -56,7 +58,9 @@ let stringifyCompletionItem c =
   c.kind
   (c.tags |> List.map string_of_int |> array)
   (Json.escape c.detail)
-  (stringifyMarkupContent c.documentation)
+  (match c.documentation with
+  | None -> null
+  | Some doc -> stringifyMarkupContent doc)
 
 let stringifyHover h =
   Printf.sprintf {|{"contents": "%s"}|}
@@ -66,5 +70,3 @@ let stringifyLocation h =
   Printf.sprintf {|{"uri": "%s", "range": %s}|}
   (Json.escape h.uri)
   (stringifyRange h.range)
-
-let null = "null"

analysis/tests/src/expected/Complete.res.txt

@@ -22,7 +22,7 @@ Complete tests/src/Complete.res 0:2
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, t<'b>, (. 'a, 'b) => 'c) => t<'c>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "map",
     "kind": 12,
@@ -34,19 +34,19 @@ Complete tests/src/Complete.res 0:2
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, (. int, 'a) => 'b) => t<'b>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "mapU",
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, (. 'a) => 'b) => t<'b>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "makeByU",
     "kind": 12,
     "tags": [],
     "detail": "(int, (. int) => 'a) => t<'a>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "mapReverse2",
     "kind": 12,
@@ -64,7 +64,7 @@ Complete tests/src/Complete.res 0:2
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, (. 'a) => 'b) => t<'b>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]
 
 Complete tests/src/Complete.res 1:2
@@ -73,7 +73,7 @@ Complete tests/src/Complete.res 1:2
     "kind": 9,
     "tags": [],
     "detail": "module",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "fold_left",
     "kind": 12,
@@ -211,7 +211,7 @@ Complete tests/src/Complete.res 1:2
     "kind": 12,
     "tags": [],
     "detail": "(array<'a>, int) => 'a",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "make_matrix",
     "kind": 12,
@@ -241,7 +241,7 @@ Complete tests/src/Complete.res 1:2
     "kind": 12,
     "tags": [],
     "detail": "(array<'a>, int, 'a) => unit",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "create_matrix",
     "kind": 12,
@@ -352,13 +352,13 @@ Complete tests/src/Complete.res 19:2
     "kind": 4,
     "tags": [],
     "detail": "int",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "name",
     "kind": 4,
     "tags": [],
     "detail": "string",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]
 
 Complete tests/src/Complete.res 21:2
@@ -367,13 +367,13 @@ Complete tests/src/Complete.res 21:2
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, ('a, int) => 'b) => t<'b>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "Js.Array2.map",
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, 'a => 'b) => t<'b>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]
 
 Complete tests/src/Complete.res 23:2
@@ -406,13 +406,13 @@ Complete tests/src/Complete.res 36:2
     "kind": 12,
     "tags": [],
     "detail": "(t, int) => t",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "ForAuto.abd",
     "kind": 12,
     "tags": [],
     "detail": "(t, int) => t",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]
 
 Complete tests/src/Complete.res 38:2
@@ -436,7 +436,7 @@ Complete tests/src/Complete.res 50:2
     "kind": 12,
     "tags": [],
     "detail": "int",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]
 
 Complete tests/src/Complete.res 52:2
@@ -445,12 +445,12 @@ Complete tests/src/Complete.res 52:2
     "kind": 4,
     "tags": [],
     "detail": "string",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "zoo",
     "kind": 4,
     "tags": [],
     "detail": "option<int>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]
 

analysis/tests/src/expected/Jsx.res.txt

@@ -10,18 +10,18 @@ Complete tests/src/Jsx.res 10:2
     "kind": 4,
     "tags": [],
     "detail": "string",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "first",
     "kind": 4,
     "tags": [],
     "detail": "string",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }, {
     "label": "fun",
     "kind": 4,
     "tags": [],
     "detail": "option<string>",
-    "documentation": {"kind": "markdown", "value": ""}
+    "documentation": null
   }]