change strategy for removing dot on completion

Author: zth

analysis/src/Codemod.ml

@@ -41,7 +41,7 @@ let transform ~path ~pos ~debug ~typ ~hint =
         if debug then print_endline "Found no result";
         exit 1
       | Some switchExpr ->
-        printExpr ~range:(Xform.rangeOfLoc switchExpr.pexp_loc) switchExpr)
+        printExpr ~range:(Loc.rangeOfLoc switchExpr.pexp_loc) switchExpr)
     | _ ->
       if debug then print_endline "Mismatch in expected structure";
       exit 1)

analysis/src/CompletionBackEnd.ml

@@ -664,8 +664,8 @@ let completionsForPipeFromCompletionPath ~envCompletionIsMadeFrom ~opens ~pos
   in
   completions
 
-let getPipeCompletions ~env ~full ~identifierLoc ~debug ~envCompletionIsMadeFrom
-    ~opens ~pos ~scope ~prefix ~rawOpens ~inJsx
+let getPipeCompletions ~env ~full ~identifierLoc ?posOfDot ~debug
+    ~envCompletionIsMadeFrom ~opens ~pos ~scope ~prefix ~rawOpens ~inJsx
     ?(mainCompletionsAreSynthetic = false) ?(formatCompletionsWithPipes = false)
     typ =
   let env, typ =
@@ -750,8 +750,8 @@ let getPipeCompletions ~env ~full ~identifierLoc ~debug ~envCompletionIsMadeFrom
       allCompletions
       |> List.filter_map (fun (c : Completion.t) ->
              c
-             |> TypeUtils.transformCompletionToPipeCompletion ~env
-                  ~replaceRange:identifierLoc ~synthetic:c.synthetic)
+             |> TypeUtils.transformCompletionToPipeCompletion ~env ?posOfDot
+                  ~synthetic:c.synthetic)
     else allCompletions
 
 let rec digToRecordFieldsForCompletion ~debug ~package ~opens ~full ~pos ~env
@@ -772,8 +772,8 @@ let rec digToRecordFieldsForCompletion ~debug ~package ~opens ~full ~pos ~env
   | {kind = Type {kind = Record fields}} :: _ -> Some fields
   | _ -> None
 
-let mkItem ?data ?(range : Location.t option) name ~kind ~detail ~deprecated
-    ~docstring =
+let mkItem ?data ?additionalTextEdits name ~kind ~detail ~deprecated ~docstring
+    =
   let docContent =
     (match deprecated with
     | None -> ""
@@ -802,23 +802,7 @@ let mkItem ?data ?(range : Location.t option) name ~kind ~detail ~deprecated
       insertTextFormat = None;
       filterText = None;
       data;
-      range =
-        (match range with
-        | None -> None
-        | Some range ->
-          Some
-            {
-              start =
-                {
-                  line = range.loc_start.pos_lnum - 1;
-                  character = range.loc_start.pos_cnum - range.loc_start.pos_bol;
-                };
-              end_ =
-                {
-                  line = range.loc_end.pos_lnum - 1;
-                  character = range.loc_end.pos_cnum - range.loc_end.pos_bol;
-                };
-            });
+      additionalTextEdits;
     }
 
 let completionToItem
@@ -833,10 +817,10 @@ let completionToItem
       filterText;
       detail;
       env;
-      range;
+      additionalTextEdits;
     } ~full =
   let item =
-    mkItem name ?range
+    mkItem name ?additionalTextEdits
       ?data:(kindToData (full.file.uri |> Uri.toPath) kind)
       ~kind:(Completion.kindToInt kind)
       ~deprecated
@@ -1096,7 +1080,7 @@ and getCompletionsForContextPath ~debug ~full ~opens ~rawOpens ~pos ~env ~exact
     path @ [fieldName]
     |> getCompletionsForPath ~debug ~opens ~full ~pos ~exact
          ~completionContext:Field ~env ~scope
-  | CPField {contextPath = cp; fieldName; fieldNameLoc} -> (
+  | CPField {contextPath = cp; fieldName; fieldNameLoc; posOfDot} -> (
     if Debug.verbose () then print_endline "[dot_completion]--> Triggered";
     let completionsFromCtxPath =
       cp
@@ -1116,10 +1100,10 @@ and getCompletionsForContextPath ~debug ~full ~opens ~rawOpens ~pos ~env ~exact
     | Some (typ, env) ->
       let fieldCompletions =
         DotCompletionUtils.fieldCompletionsForDotCompletion typ ~env ~package
-          ~prefix:fieldName ~fieldNameLoc ~exact
+          ~prefix:fieldName ?posOfDot ~exact
       in
       let pipeCompletions =
-        getPipeCompletions ~env ~full ~identifierLoc:fieldNameLoc
+        getPipeCompletions ~env ~full ~identifierLoc:fieldNameLoc ?posOfDot
           ~envCompletionIsMadeFrom ~debug ~opens ~rawOpens ~scope ~pos
           ~inJsx:false ~prefix:fieldName ~formatCompletionsWithPipes:true typ
       in

analysis/src/CompletionFrontEnd.ml

@@ -225,7 +225,9 @@ let rec exprToContextPathInner (e : Parsetree.expression) =
   | Pexp_field (e1, {txt = Lident name; loc}) -> (
     match exprToContextPath e1 with
     | Some contextPath ->
-      Some (CPField {contextPath; fieldName = name; fieldNameLoc = loc})
+      Some
+        (CPField
+           {contextPath; fieldName = name; fieldNameLoc = loc; posOfDot = None})
     | _ -> None)
   | Pexp_field (_, {loc; txt = Ldot (lid, name)}) ->
     (* Case x.M.field ignore the x part *)
@@ -241,6 +243,7 @@ let rec exprToContextPathInner (e : Parsetree.expression) =
                };
            fieldName = name;
            fieldNameLoc = loc;
+           posOfDot = None;
          })
   | Pexp_send (e1, {txt}) -> (
     match exprToContextPath e1 with
@@ -332,6 +335,7 @@ let completionWithParser1 ~currentFile ~debug ~offset ~path ~posCursor
       Some text.[offsetNoWhite]
     else None
   in
+  let posOfDot = Pos.posOfDot text ~pos:posCursor ~offset in
   let charAtCursor =
     if offset < String.length text then text.[offset] else '\n'
   in
@@ -1167,6 +1171,7 @@ let completionWithParser1 ~currentFile ~debug ~offset ~path ~posCursor
                       contextPath;
                       fieldName = name;
                       fieldNameLoc = fieldName.loc;
+                      posOfDot;
                     }
                 in
                 setResult (Cpath contextPath)
@@ -1189,6 +1194,7 @@ let completionWithParser1 ~currentFile ~debug ~offset ~path ~posCursor
                        else if name = "_" then ""
                        else name);
                     fieldNameLoc = fieldName.loc;
+                    posOfDot;
                   }
               in
               setResult (Cpath contextPath)
@@ -1208,6 +1214,7 @@ let completionWithParser1 ~currentFile ~debug ~offset ~path ~posCursor
                             loc_end = e.pexp_loc.loc_end;
                             loc_ghost = false;
                           };
+                        posOfDot;
                       }))
             | None -> ())
         | Pexp_apply ({pexp_desc = Pexp_ident compName}, args)

analysis/src/DotCompletionUtils.ml

@@ -8,8 +8,8 @@ let filterRecordFields ~env ~recordAsString ~prefix ~exact fields =
                 ~kind:(SharedTypes.Completion.Field (field, recordAsString)))
          else None)
 
-let fieldCompletionsForDotCompletion typ ~env ~package ~prefix ~fieldNameLoc
-    ~exact =
+let fieldCompletionsForDotCompletion ?posOfDot typ ~env ~package ~prefix ~exact
+    =
   let asObject = typ |> TypeUtils.extractObjectType ~env ~package in
   match asObject with
   | Some (objEnv, obj) ->
@@ -22,8 +22,15 @@ let fieldCompletionsForDotCompletion typ ~env ~package ~prefix ~fieldNameLoc
              let fullObjFieldName = Printf.sprintf "[\"%s\"]" field in
              Some
                (SharedTypes.Completion.create fullObjFieldName ~synthetic:true
-                  ~range:fieldNameLoc ~insertText:fullObjFieldName ~env:objEnv
-                  ~kind:(SharedTypes.Completion.ObjLabel typ))
+                  ~insertText:fullObjFieldName ~env:objEnv
+                  ~kind:(SharedTypes.Completion.ObjLabel typ)
+                  ?additionalTextEdits:
+                    (match posOfDot with
+                    | None -> None
+                    | Some posOfDot ->
+                      Some
+                        (TypeUtils.makeAdditionalTextEditsForRemovingDot
+                           posOfDot)))
            else None)
   | None -> (
     match typ |> TypeUtils.extractRecordType ~env ~package with

analysis/src/Loc.ml

@@ -12,3 +12,12 @@ let hasPos ~pos loc = start loc <= pos && pos < end_ loc
 (** Allows the character after the end to be included. Ie when the cursor is at the 
     end of the word, like `someIdentifier<cursor>`. Useful in some scenarios. *)
 let hasPosInclusiveEnd ~pos loc = start loc <= pos && pos <= end_ loc
+
+let mkPosition (pos : Pos.t) =
+  let line, character = pos in
+  {Protocol.line; character}
+
+let rangeOfLoc (loc : t) =
+  let start = loc |> start |> mkPosition in
+  let end_ = loc |> end_ |> mkPosition in
+  {Protocol.start; end_}

analysis/src/Pos.ml

@@ -26,3 +26,19 @@ let positionToOffset text (line, character) =
     else None
 
 let posBeforeCursor pos = (fst pos, max 0 (snd pos - 1))
+
+let posOfDot text ~(pos : int * int) ~offset =
+  let rec loop i =
+    if i < 0 then None
+    else
+      match text.[i] with
+      | '.' -> Some (i + 1)
+      | '\n' -> None
+      | _ -> loop (i - 1)
+  in
+  match loop (offset - 1) with
+  | None -> None
+  | Some offsetBeforeDot ->
+    let line, col = pos in
+    let newCol = max 0 (col - (offset - offsetBeforeDot)) in
+    Some (line, newCol)

analysis/src/Protocol.ml

@@ -40,6 +40,8 @@ let insertTextFormatToInt f =
   match f with
   | Snippet -> 2
 
+type textEdit = {range: range; newText: string}
+
 type completionItem = {
   label: string;
   kind: int;
@@ -51,7 +53,7 @@ type completionItem = {
   insertText: string option;
   documentation: markupContent option;
   data: (string * string) list option;
-  range: range option;
+  additionalTextEdits: textEdit list option;
 }
 
 type location = {uri: string; range: range}
@@ -62,8 +64,6 @@ type documentSymbolItem = {
   children: documentSymbolItem list;
 }
 type renameFile = {oldUri: string; newUri: string}
-type textEdit = {range: range; newText: string}
-
 type diagnostic = {range: range; message: string; severity: int}
 
 type optionalVersionedTextDocumentIdentifier = {
@@ -105,6 +105,14 @@ let stringifyRange r =
     (stringifyPosition r.start)
     (stringifyPosition r.end_)
 
+let stringifyTextEdit (te : textEdit) =
+  Printf.sprintf
+    {|{
+      "range": %s,
+      "newText": %s
+      }|}
+    (stringifyRange te.range) (wrapInQuotes te.newText)
+
 let stringifyMarkupContent (m : markupContent) =
   Printf.sprintf {|{"kind": %s, "value": %s}|} (wrapInQuotes m.kind)
     (wrapInQuotes m.value)
@@ -143,10 +151,7 @@ let stringifyCompletionItem c =
           | Some doc -> stringifyMarkupContent doc) );
       ("sortText", optWrapInQuotes c.sortText);
       ("filterText", optWrapInQuotes c.filterText);
-      ( "insertText",
-        match c.range with
-        | Some _ -> None
-        | None -> optWrapInQuotes c.insertText );
+      ("insertText", optWrapInQuotes c.insertText);
       ( "insertTextFormat",
         match c.insertTextFormat with
         | None -> None
@@ -160,19 +165,10 @@ let stringifyCompletionItem c =
             (fields
             |> List.map (fun (key, value) -> (key, Some (wrapInQuotes value)))
             |> stringifyObject ~indentation:2) );
-      ( "textEdit",
-        match c.range with
-        | Some range ->
-          Some
-            (stringifyObject
-               [
-                 ("range", Some (stringifyRange range));
-                 ( "newText",
-                   optWrapInQuotes
-                     (match c.insertText with
-                     | None -> Some c.label
-                     | v -> v) );
-               ])
+      ( "additionalTextEdits",
+        match c.additionalTextEdits with
+        | Some additionalTextEdits ->
+          Some (additionalTextEdits |> List.map stringifyTextEdit |> array)
         | None -> None );
     ]
 
@@ -233,13 +229,6 @@ let stringifyRenameFile {oldUri; newUri} =
 }|}
     (wrapInQuotes oldUri) (wrapInQuotes newUri)
 
-let stringifyTextEdit (te : textEdit) =
-  Printf.sprintf {|{
-  "range": %s,
-  "newText": %s
-  }|}
-    (stringifyRange te.range) (wrapInQuotes te.newText)
-
 let stringifyoptionalVersionedTextDocumentIdentifier td =
   Printf.sprintf {|{
   "version": %s,

analysis/src/SharedTypes.ml

@@ -614,6 +614,7 @@ module Completable = struct
     | CPField of {
         contextPath: contextPath;
         fieldName: string;
+        posOfDot: (int * int) option;
         fieldNameLoc: Location.t;
       }
     | CPObj of contextPath * string
@@ -812,12 +813,12 @@ module Completion = struct
     detail: string option;
     typeArgContext: typeArgContext option;
     data: (string * string) list option;
-    range: Location.t option;
+    additionalTextEdits: Protocol.textEdit list option;
     synthetic: bool;
         (** Whether this item is an made up, synthetic item or not. *)
   }
 
-  let create ?(synthetic = false) ?range ?data ?typeArgContext
+  let create ?(synthetic = false) ?additionalTextEdits ?data ?typeArgContext
       ?(includesSnippets = false) ?insertText ~kind ~env ?sortText ?deprecated
       ?filterText ?detail ?(docstring = []) name =
     {
@@ -834,7 +835,7 @@ module Completion = struct
       detail;
       typeArgContext;
       data;
-      range;
+      additionalTextEdits;
       synthetic;
     }
 

analysis/src/TypeUtils.ml

@@ -1142,8 +1142,20 @@ let getFirstFnUnlabelledArgType ~env ~full t =
   | Some t -> Some (t, env)
   | _ -> None
 
+let makeAdditionalTextEditsForRemovingDot posOfDot =
+  [
+    {
+      Protocol.range =
+        {
+          start = {line = fst posOfDot; character = snd posOfDot - 1};
+          end_ = {line = fst posOfDot; character = snd posOfDot};
+        };
+      newText = "";
+    };
+  ]
+
 (** Turns a completion into a pipe completion. *)
-let transformCompletionToPipeCompletion ?(synthetic = false) ~env ~replaceRange
+let transformCompletionToPipeCompletion ?(synthetic = false) ~env ?posOfDot
     (completion : Completion.t) =
   let name = completion.name in
   let nameWithPipe = "->" ^ name in
@@ -1154,8 +1166,11 @@ let transformCompletionToPipeCompletion ?(synthetic = false) ~env ~replaceRange
       sortText = Some (name |> String.split_on_char '.' |> List.rev |> List.hd);
       insertText = Some nameWithPipe;
       env;
-      range = Some replaceRange;
       synthetic;
+      additionalTextEdits =
+        (match posOfDot with
+        | None -> None
+        | Some posOfDot -> Some (makeAdditionalTextEditsForRemovingDot posOfDot));
     }
 
 (** This takes a type expr and the env that type expr was found in, and produces a globally unique 
@@ -1202,7 +1217,7 @@ let rec findRootTypeId ~full ~env (t : Types.type_expr) =
   | _ -> None
 
 (** Filters out completions that are not pipeable from a list of completions. *)
-let filterPipeableFunctions ~env ~full ?synthetic ?targetTypeId ?replaceRange
+let filterPipeableFunctions ~env ~full ?synthetic ?targetTypeId ?posOfDot
     completions =
   match targetTypeId with
   | None -> completions
@@ -1222,10 +1237,10 @@ let filterPipeableFunctions ~env ~full ?synthetic ?targetTypeId ?replaceRange
            in
            match thisCompletionItemTypeId with
            | Some mainTypeId when mainTypeId = targetTypeId -> (
-             match replaceRange with
+             match posOfDot with
              | None -> Some completion
-             | Some replaceRange ->
-               transformCompletionToPipeCompletion ?synthetic ~env ~replaceRange
+             | Some posOfDot ->
+               transformCompletionToPipeCompletion ?synthetic ~env ~posOfDot
                  completion)
            | _ -> None)