Skip to content

Commit 12ec628

Browse files
zthzth
committed
refactor pipe completion to handle builtins properly in new approach when resolving aliased types
1 parent b4807d8 commit 12ec628

File tree

3 files changed

+164
-115
lines changed

3 files changed

+164
-115
lines changed

‎analysis/src/CompletionBackEnd.ml

Lines changed: 67 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -722,93 +722,52 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
722722
~exact:true ~scope
723723
|> completionsGetTypeEnv
724724
with
725+
| None -> []
725726
| Some (typ, envFromCompletionItem) -> (
726727
let env, typ =
727-
typ |> TypeUtils.resolveTypeForPipeCompletion ~env ~package
728-
in
729-
730-
(* If the type we're completing on is a type parameter, we won't be able to do
731-
completion unless we know what that type parameter is compiled as. This
732-
attempts to look up the compiled type for that type parameter by looking
733-
for compiled information at the loc of that expression. *)
734-
let typ =
735-
match typ with
736-
| {Types.desc = Tvar _} -> (
737-
match
738-
TypeUtils.findReturnTypeOfFunctionAtLoc lhsLoc ~env ~full
739-
~debug:false
740-
with
741-
| None -> typ
742-
| Some typFromLoc -> typFromLoc)
743-
| _ -> typ
744-
in
745-
let {
746-
arrayModulePath;
747-
optionModulePath;
748-
stringModulePath;
749-
intModulePath;
750-
floatModulePath;
751-
promiseModulePath;
752-
listModulePath;
753-
resultModulePath;
754-
} =
755-
package.builtInCompletionModules
756-
in
757-
let getBuiltinTypePath path =
758-
match path with
759-
| Path.Pident id when Ident.name id = "array" -> Some arrayModulePath
760-
| Path.Pident id when Ident.name id = "option" -> Some optionModulePath
761-
| Path.Pident id when Ident.name id = "string" -> Some stringModulePath
762-
| Path.Pident id when Ident.name id = "int" -> Some intModulePath
763-
| Path.Pident id when Ident.name id = "float" -> Some floatModulePath
764-
| Path.Pident id when Ident.name id = "promise" ->
765-
Some promiseModulePath
766-
| Path.Pident id when Ident.name id = "list" -> Some listModulePath
767-
| Path.Pident id when Ident.name id = "result" -> Some resultModulePath
768-
| Path.Pident id when Ident.name id = "lazy_t" -> Some ["Lazy"]
769-
| Path.Pident id when Ident.name id = "char" -> Some ["Char"]
770-
| Pdot (Pident id, "result", _) when Ident.name id = "Pervasives" ->
771-
Some resultModulePath
772-
| _ -> None
773-
in
774-
let rec expandPath (path : Path.t) =
775-
match path with
776-
| Pident id -> [Ident.name id]
777-
| Pdot (p, s, _) -> s :: expandPath p
778-
| Papply _ -> []
779-
in
780-
let getTypePath typ =
781-
match typ.Types.desc with
782-
| Tconstr (path, _typeArgs, _)
783-
| Tlink {desc = Tconstr (path, _typeArgs, _)}
784-
| Tsubst {desc = Tconstr (path, _typeArgs, _)}
785-
| Tpoly ({desc = Tconstr (path, _typeArgs, _)}, []) ->
786-
Some path
787-
| _ -> None
788-
in
789-
let rec removeRawOpen rawOpen modulePath =
790-
match (rawOpen, modulePath) with
791-
| [_], _ -> Some modulePath
792-
| s :: inner, first :: restPath when s = first ->
793-
removeRawOpen inner restPath
794-
| _ -> None
795-
in
796-
let rec removeRawOpens rawOpens modulePath =
797-
match rawOpens with
798-
| rawOpen :: restOpens -> (
799-
let newModulePath = removeRawOpens restOpens modulePath in
800-
match removeRawOpen rawOpen newModulePath with
801-
| None -> newModulePath
802-
| Some mp -> mp)
803-
| [] -> modulePath
728+
typ
729+
|> TypeUtils.resolveTypeForPipeCompletion ~env ~package ~full ~lhsLoc
804730
in
805731
let completionPath =
806-
match getTypePath typ with
807-
| Some typePath -> (
808-
match getBuiltinTypePath typePath with
809-
| Some path -> Some path
810-
| None -> (
811-
match expandPath typePath with
732+
match typ with
733+
| Builtin (builtin, _) ->
734+
let {
735+
arrayModulePath;
736+
optionModulePath;
737+
stringModulePath;
738+
intModulePath;
739+
floatModulePath;
740+
promiseModulePath;
741+
listModulePath;
742+
resultModulePath;
743+
} =
744+
package.builtInCompletionModules
745+
in
746+
Some
747+
(match builtin with
748+
| Array -> arrayModulePath
749+
| Option -> optionModulePath
750+
| String -> stringModulePath
751+
| Int -> intModulePath
752+
| Float -> floatModulePath
753+
| Promise -> promiseModulePath
754+
| List -> listModulePath
755+
| Result -> resultModulePath
756+
| Lazy -> ["Lazy"]
757+
| Char -> ["Char"])
758+
| TypExpr t -> (
759+
let rec expandPath (path : Path.t) =
760+
match path with
761+
| Pident id -> [Ident.name id]
762+
| Pdot (p, s, _) -> s :: expandPath p
763+
| Papply _ -> []
764+
in
765+
match t.Types.desc with
766+
| Tconstr (path, _typeArgs, _)
767+
| Tlink {desc = Tconstr (path, _typeArgs, _)}
768+
| Tsubst {desc = Tconstr (path, _typeArgs, _)}
769+
| Tpoly ({desc = Tconstr (path, _typeArgs, _)}, []) -> (
770+
match expandPath path with
812771
| _ :: pathRev ->
813772
(* type path is relative to the completion environment
814773
express it from the root of the file *)
@@ -823,11 +782,27 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
823782
else envFromCompletionItem.file.moduleName :: pathFromEnv_
824783
in
825784
Some pathFromEnv
826-
| _ -> None))
827-
| None -> None
785+
| _ -> None)
786+
| _ -> None)
828787
in
829788
match completionPath with
830789
| Some completionPath -> (
790+
let rec removeRawOpen rawOpen modulePath =
791+
match (rawOpen, modulePath) with
792+
| [_], _ -> Some modulePath
793+
| s :: inner, first :: restPath when s = first ->
794+
removeRawOpen inner restPath
795+
| _ -> None
796+
in
797+
let rec removeRawOpens rawOpens modulePath =
798+
match rawOpens with
799+
| rawOpen :: restOpens -> (
800+
let newModulePath = removeRawOpens restOpens modulePath in
801+
match removeRawOpen rawOpen newModulePath with
802+
| None -> newModulePath
803+
| Some mp -> mp)
804+
| [] -> modulePath
805+
in
831806
let completionPathMinusOpens =
832807
completionPath
833808
|> removeRawOpens package.opens
@@ -855,17 +830,16 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
855830
(* We add React element functions to the completion if we're in a JSX context *)
856831
let forJsxCompletion =
857832
if inJsx then
858-
match getTypePath typ with
859-
| Some (Path.Pident id) when Ident.name id = "int" -> Some "int"
860-
| Some (Path.Pident id) when Ident.name id = "float" -> Some "float"
861-
| Some (Path.Pident id) when Ident.name id = "string" ->
862-
Some "string"
863-
| Some (Path.Pident id) when Ident.name id = "array" -> Some "array"
833+
match typ with
834+
| Builtin (Int, t) -> Some ("int", t)
835+
| Builtin (Float, t) -> Some ("float", t)
836+
| Builtin (String, t) -> Some ("string", t)
837+
| Builtin (Array, t) -> Some ("array", t)
864838
| _ -> None
865839
else None
866840
in
867841
match forJsxCompletion with
868-
| Some builtinNameToComplete
842+
| Some (builtinNameToComplete, typ)
869843
when Utils.checkName builtinNameToComplete ~prefix:funNamePrefix
870844
~exact:false ->
871845
[
@@ -881,8 +855,7 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
881855
]
882856
@ completions
883857
| _ -> completions)
884-
| None -> [])
885-
| None -> [])
858+
| None -> []))
886859
| CTuple ctxPaths ->
887860
(* Turn a list of context paths into a list of type expressions. *)
888861
let typeExrps =

‎analysis/src/TypeUtils.ml

Lines changed: 84 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -148,18 +148,90 @@ let rec extractType ~env ~package (t : Types.type_expr) =
148148
Some (Tpolyvariant {env; constructors; typeExpr = t})
149149
| _ -> None
150150

151-
let rec resolveTypeForPipeCompletion ~env ~package (t : Types.type_expr) =
152-
match t.desc with
153-
| Tlink t1 | Tsubst t1 | Tpoly (t1, []) ->
154-
resolveTypeForPipeCompletion ~env ~package t1
155-
(* Don't descend into types named "t". Type t is a convention in the ReScript ecosystem. *)
156-
| Tconstr (path, _, _) when path |> Path.last = "t" -> (env, t)
157-
| Tconstr (path, _, _) -> (
158-
match References.digConstructor ~env ~package path with
159-
| Some (env, {item = {decl = {type_manifest = Some typ}}}) ->
160-
resolveTypeForPipeCompletion ~env ~package typ
161-
| _ -> (env, t))
162-
| _ -> (env, t)
151+
let findReturnTypeOfFunctionAtLoc loc ~(env : QueryEnv.t) ~full ~debug =
152+
match References.getLocItem ~full ~pos:(loc |> Loc.end_) ~debug with
153+
| Some {locType = Typed (_, typExpr, _)} -> (
154+
match extractFunctionType ~env ~package:full.package typExpr with
155+
| args, tRet when args <> [] -> Some tRet
156+
| _ -> None)
157+
| _ -> None
158+
159+
type builtinType =
160+
| Array
161+
| Option
162+
| String
163+
| Int
164+
| Float
165+
| Promise
166+
| List
167+
| Result
168+
| Lazy
169+
| Char
170+
171+
type pipeCompletionType =
172+
| Builtin of builtinType * Types.type_expr
173+
| TypExpr of Types.type_expr
174+
175+
let getBuiltinFromTypePath path =
176+
match path with
177+
| Path.Pident id when Ident.name id = "array" -> Some Array
178+
| Path.Pident id when Ident.name id = "option" -> Some Option
179+
| Path.Pident id when Ident.name id = "string" -> Some String
180+
| Path.Pident id when Ident.name id = "int" -> Some Int
181+
| Path.Pident id when Ident.name id = "float" -> Some Float
182+
| Path.Pident id when Ident.name id = "promise" -> Some Promise
183+
| Path.Pident id when Ident.name id = "list" -> Some List
184+
| Path.Pident id when Ident.name id = "result" -> Some Result
185+
| Path.Pident id when Ident.name id = "lazy_t" -> Some Lazy
186+
| Path.Pident id when Ident.name id = "char" -> Some Char
187+
| Pdot (Pident id, "result", _) when Ident.name id = "Pervasives" ->
188+
Some Result
189+
| _ -> None
190+
191+
let rec resolveTypeForPipeCompletion ~env ~package ~lhsLoc ~full
192+
(t : Types.type_expr) =
193+
let builtin =
194+
match t.desc with
195+
| Tconstr (path, _typeArgs, _)
196+
| Tlink {desc = Tconstr (path, _typeArgs, _)}
197+
| Tsubst {desc = Tconstr (path, _typeArgs, _)}
198+
| Tpoly ({desc = Tconstr (path, _typeArgs, _)}, []) ->
199+
path |> getBuiltinFromTypePath
200+
| _ -> None
201+
in
202+
match builtin with
203+
| Some builtin -> (env, Builtin (builtin, t))
204+
| None -> (
205+
(* If the type we're completing on is a type parameter, we won't be able to
206+
do completion unless we know what that type parameter is compiled as.
207+
This attempts to look up the compiled type for that type parameter by
208+
looking for compiled information at the loc of that expression. *)
209+
let typFromLoc =
210+
match t with
211+
| {Types.desc = Tvar _} -> (
212+
match findReturnTypeOfFunctionAtLoc lhsLoc ~env ~full ~debug:false with
213+
| None -> None
214+
| Some typFromLoc -> Some typFromLoc)
215+
| _ -> None
216+
in
217+
match typFromLoc with
218+
| Some typFromLoc ->
219+
typFromLoc |> resolveTypeForPipeCompletion ~lhsLoc ~env ~package ~full
220+
| None ->
221+
let rec digToRelevantType ~env ~package (t : Types.type_expr) =
222+
match t.desc with
223+
| Tlink t1 | Tsubst t1 | Tpoly (t1, []) ->
224+
digToRelevantType ~env ~package t1
225+
(* Don't descend into types named "t". Type t is a convention in the ReScript ecosystem. *)
226+
| Tconstr (path, _, _) when path |> Path.last = "t" -> (env, TypExpr t)
227+
| Tconstr (path, _, _) -> (
228+
match References.digConstructor ~env ~package path with
229+
| Some (env, {item = {decl = {type_manifest = Some typ}}}) ->
230+
digToRelevantType ~env ~package typ
231+
| _ -> (env, TypExpr t))
232+
| _ -> (env, TypExpr t)
233+
in
234+
digToRelevantType ~env ~package t)
163235

164236
(** This moves through a nested path via a set of instructions, trying to resolve the type at the end of the path. *)
165237
let rec resolveNested (typ : completionType) ~env ~package ~nested =
@@ -224,14 +296,6 @@ let rec resolveNested (typ : completionType) ~env ~package ~nested =
224296
TypeExpr typ |> resolveNested ~env ~package ~nested
225297
| _ -> None)
226298

227-
let findReturnTypeOfFunctionAtLoc loc ~(env : QueryEnv.t) ~full ~debug =
228-
match References.getLocItem ~full ~pos:(loc |> Loc.end_) ~debug with
229-
| Some {locType = Typed (_, typExpr, _)} -> (
230-
match extractFunctionType ~env ~package:full.package typExpr with
231-
| args, tRet when args <> [] -> Some tRet
232-
| _ -> None)
233-
| _ -> None
234-
235299
let getArgs ~env (t : Types.type_expr) ~full =
236300
let rec getArgsLoop ~env (t : Types.type_expr) ~full ~currentArgumentPosition
237301
=

‎analysis/tests/src/expected/Completion.res.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1745,5 +1745,17 @@ posCursor:[425:8] posNoWhite:[425:7] Found expr:[425:3->425:8]
17451745
Completable: Cpath Value[ok]->g
17461746
Raw opens: 2 Shadow.B.place holder ... Shadow.A.place holder
17471747
Resolved opens 2 Completion.res Completion.res
1748-
[]
1748+
[{
1749+
"label": "Belt.Result.getExn",
1750+
"kind": 12,
1751+
"tags": [],
1752+
"detail": "t<'a, 'b> => 'a",
1753+
"documentation": {"kind": "markdown", "value": "\n `getExn(res)`: when `res` is `Ok(n)`, returns `n` when `res` is `Error(m)`, raise an exception\n\n ```res example\n Belt.Result.getExn(Belt.Result.Ok(42)) == 42\n\n Belt.Result.getExn(Belt.Result.Error(\"Invalid data\")) /* raises exception */\n ```\n"}
1754+
}, {
1755+
"label": "Belt.Result.getWithDefault",
1756+
"kind": 12,
1757+
"tags": [],
1758+
"detail": "(t<'a, 'b>, 'a) => 'a",
1759+
"documentation": {"kind": "markdown", "value": "\n `getWithDefault(res, defaultValue)`: If `res` is `Ok(n)`, returns `n`,\n otherwise `default`\n\n ```res example\n Belt.Result.getWithDefault(Ok(42), 0) == 42\n\n Belt.Result.getWithDefault(Error(\"Invalid Data\"), 0) == 0\n ```\n"}
1760+
}]
17491761

0 commit comments

Comments
 (0)