Move completable to own module.

Author: cristianoc

analysis/src/Commands.ml

@@ -13,7 +13,7 @@ let completion ~debug ~path ~pos ~currentFile =
         | Some (completable, scope) -> (
           if debug then
             Printf.printf "Completable: %s\n"
-              (SharedTypes.completableToString completable);
+              (SharedTypes.Completable.toString completable);
           (* Only perform expensive ast operations if there are completables *)
           match Cmt.fromPath ~path with
           | None -> []

analysis/src/Completion.ml

@@ -47,7 +47,7 @@ let findJsxPropsCompletable ~jsxProps ~endPos ~posBeforeCursor ~posAfterCompName
     match props with
     | prop :: rest ->
       if prop.posStart <= posBeforeCursor && posBeforeCursor < prop.posEnd then
-        Some (Cjsx (jsxProps.componentPath, prop.name, allLabels))
+        Some (Completable.Cjsx (jsxProps.componentPath, prop.name, allLabels))
       else if
         prop.posEnd <= posBeforeCursor
         && posBeforeCursor < Loc.start prop.exp.pexp_loc
@@ -183,7 +183,7 @@ let findExpApplyCompletable ~(args : arg list) ~endPos ~posBeforeCursor
       if
         labelled.posStart <= posBeforeCursor
         && posBeforeCursor < labelled.posEnd
-      then Some (Clabel (funPath, labelled.name, allNames))
+      then Some (Completable.Clabel (funPath, labelled.name, allNames))
       else if exp.pexp_loc |> Loc.hasPos ~pos:posBeforeCursor then None
       else loop rest
     | {label = None; exp} :: rest ->
@@ -266,7 +266,7 @@ let extractExpApplyArgs ~text ~(funName : Longident.t Location.loc) ~args =
 
 let rec exprToContextPath (e : Parsetree.expression) =
   match e.pexp_desc with
-  | Pexp_constant (Pconst_string _) -> Some CPString
+  | Pexp_constant (Pconst_string _) -> Some Completable.CPString
   | Pexp_array _ -> Some CPArray
   | Pexp_ident {txt} -> Some (CPId (Utils.flattenLongIdent txt, Value))
   | Pexp_field (e1, {txt = Lident name}) -> (
@@ -459,7 +459,7 @@ let completionWithParser ~debug ~path ~posCursor ~currentFile ~text =
         if debug then
           Printf.printf "Attribute id:%s:%s label:%s\n" id.txt
             (Loc.toString id.loc) label;
-        setResult (Cdecorator label)
+        setResult (Completable.Cdecorator label)
       | _ -> ());
     Ast_iterator.default_iterator.attribute iterator (id, payload)
   in
@@ -540,13 +540,13 @@ let completionWithParser ~debug ~path ~posCursor ~currentFile ~text =
             | Lident name -> (
               match exprToContextPath e with
               | Some contextPath ->
-                let contextPath = CPField (contextPath, name) in
+                let contextPath = Completable.CPField (contextPath, name) in
                 setResult (Cpath contextPath)
               | None -> ())
             | Ldot (id, name) ->
               (* Case x.M.field ignore the x part *)
               let contextPath =
-                CPField
+                Completable.CPField
                   ( CPId (Utils.flattenLongIdent id, Module),
                     if name = "_" then "" else name )
               in

analysis/src/NewCompletions.ml

@@ -665,7 +665,7 @@ let detail name (kind : Completion.kind) =
   | Constructor (c, s) -> showConstructor c ^ "\n\n" ^ s
 
 let findAllCompletions ~(env : QueryEnv.t) ~prefix ~exact ~namesUsed
-    ~(completionContext : completionContext) =
+    ~(completionContext : Completable.completionContext) =
   Log.log ("findAllCompletions uri:" ^ Uri2.toString env.file.uri);
   match completionContext with
   | Value ->
@@ -846,7 +846,7 @@ let findLocalCompletionsForModules ~env ~prefix ~exact ~opens ~scope =
   List.rev_append !resultRev valuesFromOpens
 
 let findLocalCompletionsWithOpens ~pos ~(env : QueryEnv.t) ~prefix ~exact ~opens
-    ~scope ~(completionContext : completionContext) =
+    ~scope ~(completionContext : Completable.completionContext) =
   (* TODO: handle arbitrary interleaving of opens and local bindings correctly *)
   Log.log
     ("findLocalCompletionsWithOpens uri:" ^ Uri2.toString env.file.uri ^ " pos:"
@@ -963,7 +963,7 @@ let completionsGetTypeEnv = function
   | _ -> None
 
 let rec getCompletionsForContextPath ~package ~opens ~rawOpens ~allFiles ~pos
-    ~env ~exact ~scope (contextPath : contextPath) =
+    ~env ~exact ~scope (contextPath : Completable.contextPath) =
   match contextPath with
   | CPString ->
     [
@@ -1148,7 +1148,7 @@ let getOpens ~rawOpens ~package ~env =
   (* Last open takes priority *)
   List.rev resolvedOpens
 
-let processCompletable ~package ~scope ~env ~pos (completable : completable) =
+let processCompletable ~package ~scope ~env ~pos (completable : Completable.t) =
   let rawOpens = Scope.getRawOpens scope in
   let opens = getOpens ~rawOpens ~package ~env in
   let allFiles = FileSet.union package.projectFiles package.dependenciesFiles in
@@ -1306,5 +1306,6 @@ let processCompletable ~package ~scope ~env ~pos (completable : completable) =
            Utils.startsWith name prefix && not (List.mem name identsSeen))
     |> List.map mkLabel
 
-let computeCompletions ~(completable : completable) ~package ~pos ~scope ~env =
+let computeCompletions ~(completable : Completable.t) ~package ~pos ~scope ~env
+    =
   completable |> processCompletable ~package ~scope ~env ~pos

analysis/src/SharedTypes.ml

@@ -396,47 +396,49 @@ let locItemToString {loc = {Location.loc_start; loc_end}; locType} =
 (* needed for debugging *)
 let _ = locItemToString
 
-(* Completion context *)
-type completionContext = Type | Value | Module | Field
-
-type contextPath =
-  | CPString
-  | CPArray
-  | CPId of string list * completionContext
-  | CPField of contextPath * string
-  | CPObj of contextPath * string
-  | CPPipe of contextPath * string
-
-type completable =
-  | Cdecorator of string  (** e.g. @module *)
-  | Clabel of string list * string * string list
-      (** e.g. (["M", "foo"], "label", ["l1", "l2"]) for M.foo(...~l1...~l2...~label...) *)
-  | Cpath of contextPath
-  | Cjsx of string list * string * string list
-      (** E.g. (["M", "Comp"], "id", ["id1", "id2"]) for <M.Comp id1=... id2=... ... id *)
-
-let completableToString =
-  let str s = if s = "" then "\"\"" else s in
-  let list l = "[" ^ (l |> List.map str |> String.concat ", ") ^ "]" in
-  let completionContextToString = function
-    | Value -> "Value"
-    | Type -> "Type"
-    | Module -> "Module"
-    | Field -> "Field"
-  in
-  let rec contextPathToString = function
-    | CPString -> "string"
-    | CPArray -> "array"
-    | CPId (sl, completionContext) ->
-      completionContextToString completionContext ^ list sl
-    | CPField (cp, s) -> contextPathToString cp ^ "." ^ str s
-    | CPObj (cp, s) -> contextPathToString cp ^ "[\"" ^ s ^ "\"]"
-    | CPPipe (cp, s) -> contextPathToString cp ^ "->" ^ s
-  in
-  function
-  | Cpath cp -> "Cpath " ^ contextPathToString cp
-  | Cdecorator s -> "Cdecorator(" ^ str s ^ ")"
-  | Clabel (sl1, s, sl2) ->
-    "Clabel(" ^ (sl1 |> list) ^ ", " ^ str s ^ ", " ^ (sl2 |> list) ^ ")"
-  | Cjsx (sl1, s, sl2) ->
-    "Cjsx(" ^ (sl1 |> list) ^ ", " ^ str s ^ ", " ^ (sl2 |> list) ^ ")"
+module Completable = struct
+  (* Completion context *)
+  type completionContext = Type | Value | Module | Field
+
+  type contextPath =
+    | CPString
+    | CPArray
+    | CPId of string list * completionContext
+    | CPField of contextPath * string
+    | CPObj of contextPath * string
+    | CPPipe of contextPath * string
+
+  type t =
+    | Cdecorator of string  (** e.g. @module *)
+    | Clabel of string list * string * string list
+        (** e.g. (["M", "foo"], "label", ["l1", "l2"]) for M.foo(...~l1...~l2...~label...) *)
+    | Cpath of contextPath
+    | Cjsx of string list * string * string list
+        (** E.g. (["M", "Comp"], "id", ["id1", "id2"]) for <M.Comp id1=... id2=... ... id *)
+
+  let toString =
+    let str s = if s = "" then "\"\"" else s in
+    let list l = "[" ^ (l |> List.map str |> String.concat ", ") ^ "]" in
+    let completionContextToString = function
+      | Value -> "Value"
+      | Type -> "Type"
+      | Module -> "Module"
+      | Field -> "Field"
+    in
+    let rec contextPathToString = function
+      | CPString -> "string"
+      | CPArray -> "array"
+      | CPId (sl, completionContext) ->
+        completionContextToString completionContext ^ list sl
+      | CPField (cp, s) -> contextPathToString cp ^ "." ^ str s
+      | CPObj (cp, s) -> contextPathToString cp ^ "[\"" ^ s ^ "\"]"
+      | CPPipe (cp, s) -> contextPathToString cp ^ "->" ^ s
+    in
+    function
+    | Cpath cp -> "Cpath " ^ contextPathToString cp
+    | Cdecorator s -> "Cdecorator(" ^ str s ^ ")"
+    | Clabel (sl1, s, sl2) ->
+      "Clabel(" ^ (sl1 |> list) ^ ", " ^ str s ^ ", " ^ (sl2 |> list) ^ ")"
+    | Cjsx (sl1, s, sl2) ->
+      "Cjsx(" ^ (sl1 |> list) ^ ", " ^ str s ^ ", " ^ (sl2 |> list) ^ ")"
+end