Skip to content

Show docstrings from more sources #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 12, 2023
Merged

Show docstrings from more sources #694

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
825f00c
add failing tests for inline records in completing patterns
zth Jan 11, 2023
6718af8
docstrings for record fields
zth Jan 11, 2023
c685169
wire up constructor docstrings (even though the parser doesnt handle …
zth Jan 12, 2023
08e4b96
reorder constructor hover details so that the constructor + eventual …
zth Jan 12, 2023
bfd52f7
refactor and fixes
zth Jan 12, 2023
0710281
changelog
zth Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 47 additions & 29 deletions analysis/src/CompletionBackEnd.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,8 @@ let completionForExporteds iterExported getDeclared ~prefix ~exact ~env
res :=
{
(Completion.create ~name:declared.name.txt ~env
~kind:(transformContents declared.item))
~kind:(transformContents declared.item)
())
with
deprecated = declared.deprecated;
docstring = declared.docstring;
Expand Down Expand Up @@ -597,10 +598,11 @@ let completionsForExportedConstructors ~(env : QueryEnv.t) ~prefix ~exact
if not (Hashtbl.mem namesUsed name) then
let () = Hashtbl.add namesUsed name () in
Some
(Completion.create ~name ~env
(Completion.create ~name ~env ~docstring:c.docstring
~kind:
(Completion.Constructor
(c, t.item.decl |> Shared.declToString t.name.txt)))
(c, t.item.decl |> Shared.declToString t.name.txt))
())
else None))
@ !res
| _ -> ());
Expand All @@ -619,10 +621,11 @@ let completionForExportedFields ~(env : QueryEnv.t) ~prefix ~exact ~namesUsed =
if not (Hashtbl.mem namesUsed name) then
let () = Hashtbl.add namesUsed name () in
Some
(Completion.create ~name ~env
(Completion.create ~name ~env ~docstring:f.docstring
~kind:
(Completion.Field
(f, t.item.decl |> Shared.declToString t.name.txt)))
(f, t.item.decl |> Shared.declToString t.name.txt))
())
else None))
@ !res
| _ -> ());
Expand Down Expand Up @@ -801,7 +804,7 @@ let processLocalValue name loc ~prefix ~exact ~env
localTables.resultRev <-
{
(Completion.create ~name:declared.name.txt ~env
~kind:(Value declared.item))
~kind:(Value declared.item) ())
with
deprecated = declared.deprecated;
docstring = declared.docstring;
Expand All @@ -818,6 +821,7 @@ let processLocalValue name loc ~prefix ~exact ~env
(Ctype.newconstr
(Path.Pident (Ident.create "Type Not Known"))
[]))
()
:: localTables.resultRev

let processLocalConstructor name loc ~prefix ~exact ~env
Expand All @@ -836,7 +840,8 @@ let processLocalConstructor name loc ~prefix ~exact ~env
(Constructor
( declared.item,
snd declared.item.typeDecl
|> Shared.declToString (fst declared.item.typeDecl) )))
|> Shared.declToString (fst declared.item.typeDecl) ))
())
with
deprecated = declared.deprecated;
docstring = declared.docstring;
Expand All @@ -857,7 +862,7 @@ let processLocalType name loc ~prefix ~exact ~env ~(localTables : LocalTables.t)
localTables.resultRev <-
{
(Completion.create ~name:declared.name.txt ~env
~kind:(Type declared.item))
~kind:(Type declared.item) ())
with
deprecated = declared.deprecated;
docstring = declared.docstring;
Expand All @@ -878,7 +883,7 @@ let processLocalModule name loc ~prefix ~exact ~env
localTables.resultRev <-
{
(Completion.create ~name:declared.name.txt ~env
~kind:(Module declared.item))
~kind:(Module declared.item) ())
with
deprecated = declared.deprecated;
docstring = declared.docstring;
Expand Down Expand Up @@ -1139,7 +1144,8 @@ let getComplementaryCompletionsForTypedValue ~opens ~allFiles ~scope ~env prefix
(String.contains name '-')
then
Some
(Completion.create ~name ~env ~kind:(Completion.FileModule name))
(Completion.create ~name ~env ~kind:(Completion.FileModule name)
())
else None)
in
localCompletionsWithOpens @ fileModules
Expand All @@ -1164,7 +1170,7 @@ let getCompletionsForPath ~package ~opens ~allFiles ~pos ~exact ~scope
then
Some
(Completion.create ~name ~env
~kind:(Completion.FileModule name))
~kind:(Completion.FileModule name) ())
else None)
in
localCompletionsWithOpens @ fileModules
Expand Down Expand Up @@ -1353,28 +1359,32 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
Completion.create ~name:"string" ~env
~kind:
(Completion.Value
(Ctype.newconstr (Path.Pident (Ident.create "string")) []));
(Ctype.newconstr (Path.Pident (Ident.create "string")) []))
();
]
| CPInt ->
[
Completion.create ~name:"int" ~env
~kind:
(Completion.Value
(Ctype.newconstr (Path.Pident (Ident.create "int")) []));
(Ctype.newconstr (Path.Pident (Ident.create "int")) []))
();
]
| CPFloat ->
[
Completion.create ~name:"float" ~env
~kind:
(Completion.Value
(Ctype.newconstr (Path.Pident (Ident.create "float")) []));
(Ctype.newconstr (Path.Pident (Ident.create "float")) []))
();
]
| CPArray ->
[
Completion.create ~name:"array" ~env
~kind:
(Completion.Value
(Ctype.newconstr (Path.Pident (Ident.create "array")) []));
(Ctype.newconstr (Path.Pident (Ident.create "array")) []))
();
]
| CPId (path, completionContext) ->
path
Expand Down Expand Up @@ -1418,7 +1428,10 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
| args, tRet when args <> [] ->
let args = processApply args labels in
let retType = reconstructFunctionType args tRet in
[Completion.create ~name:"dummy" ~env ~kind:(Completion.Value retType)]
[
Completion.create ~name:"dummy" ~env ~kind:(Completion.Value retType)
();
]
| _ -> [])
| None -> [])
| CPField (CPId (path, Module), fieldName) ->
Expand All @@ -1441,11 +1454,13 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
if checkName field.fname.txt ~prefix:fieldName ~exact then
Some
(Completion.create ~name:field.fname.txt ~env
~docstring:field.docstring
~kind:
(Completion.Field
( field,
typDecl.item.decl
|> Shared.declToString typDecl.name.txt )))
|> Shared.declToString typDecl.name.txt ))
())
else None)
| None -> [])
| None -> [])
Expand Down Expand Up @@ -1473,7 +1488,7 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
if checkName field ~prefix:label ~exact then
Some
(Completion.create ~name:field ~env
~kind:(Completion.ObjLabel typ))
~kind:(Completion.ObjLabel typ) ())
else None)
| None -> [])
| None -> [])
Expand Down Expand Up @@ -1656,7 +1671,8 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
if List.length ctxPaths = List.length typeExrps then
[
Completion.create ~name:"dummy" ~env
~kind:(Completion.Value (Ctype.newty (Ttuple typeExrps)));
~kind:(Completion.Value (Ctype.newty (Ttuple typeExrps)))
();
]
else []
| CJsxPropValue {pathToComponent; propName} -> (
Expand All @@ -1675,7 +1691,8 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
| Some (_, typ, env) ->
[
Completion.create ~name:"dummy" ~env
~kind:(Completion.Value (Utils.unwrapIfOption typ));
~kind:(Completion.Value (Utils.unwrapIfOption typ))
();
])
| CArgument {functionContextPath; argumentLabel} -> (
let labels, env =
Expand Down Expand Up @@ -1710,7 +1727,8 @@ let rec getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos ~env
Completion.create ~name:"dummy" ~env
~kind:
(Completion.Value
(if expandOption then Utils.unwrapIfOption typ else typ));
(if expandOption then Utils.unwrapIfOption typ else typ))
();
])

let getOpens ~debug ~rawOpens ~package ~env =
Expand Down Expand Up @@ -1803,10 +1821,10 @@ let rec completeTypedValue (t : Types.type_expr) ~env ~full ~prefix
[
Completion.create ~name:"true"
~kind:(Label (t |> Shared.typeToString))
~env;
~env ();
Completion.create ~name:"false"
~kind:(Label (t |> Shared.typeToString))
~env;
~env ();
]
|> filterItems ~prefix
| Some (Tvariant {env; constructors; variantDecl; variantName}) ->
Expand Down Expand Up @@ -1867,7 +1885,7 @@ let rec completeTypedValue (t : Types.type_expr) ~env ~full ~prefix
[
Completion.create ~name:"None"
~kind:(Label (t |> Shared.typeToString))
~env;
~env ();
Completion.createWithSnippet ~name:"Some(_)"
~kind:(Label (t |> Shared.typeToString))
~env ~insertText:"Some(${1:_})" ();
Expand All @@ -1894,7 +1912,7 @@ let rec completeTypedValue (t : Types.type_expr) ~env ~full ~prefix
|> List.map (fun (field : field) ->
Completion.create ~name:field.fname.txt
~kind:(Field (field, typeExpr |> Shared.typeToString))
~env)
~env ())
|> filterItems ~prefix
| None ->
if prefix = "" then
Expand Down Expand Up @@ -1998,7 +2016,7 @@ let rec processCompletable ~debug ~full ~scope ~env ~pos ~forHover
| Cjsx ([id], prefix, identsSeen) when String.uncapitalize_ascii id = id ->
(* Lowercase JSX tag means builtin *)
let mkLabel (name, typString) =
Completion.create ~name ~kind:(Label typString) ~env
Completion.create ~name ~kind:(Label typString) ~env ()
in
let keyLabels =
if Utils.startsWith "key" prefix then [mkLabel ("key", "string")] else []
Expand All @@ -2012,7 +2030,7 @@ let rec processCompletable ~debug ~full ~scope ~env ~pos ~forHover
| Cjsx (componentPath, prefix, identsSeen) ->
let labels = getJsxLabels ~componentPath ~findTypeOfValue ~package in
let mkLabel_ name typString =
Completion.create ~name ~kind:(Label typString) ~env
Completion.create ~name ~kind:(Label typString) ~env ()
in
let mkLabel (name, typ, _env) =
mkLabel_ name (typ |> Shared.typeToString)
Expand All @@ -2031,7 +2049,7 @@ let rec processCompletable ~debug ~full ~scope ~env ~pos ~forHover
@ keyLabels
| Cdecorator prefix ->
let mkDecorator (name, docstring) =
{(Completion.create ~name ~kind:(Label "") ~env) with docstring}
{(Completion.create ~name ~kind:(Label "") ~env ()) with docstring}
in
[
( "as",
Expand Down Expand Up @@ -2288,7 +2306,7 @@ Note: The `@react.component` decorator requires the react-jsx config to be set i
| None -> []
in
let mkLabel (name, typ) =
Completion.create ~name ~kind:(Label (typ |> Shared.typeToString)) ~env
Completion.create ~name ~kind:(Label (typ |> Shared.typeToString)) ~env ()
in
labels
|> List.filter (fun (name, _t) ->
Expand Down
27 changes: 17 additions & 10 deletions analysis/src/Hover.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ let findRelevantTypesFromType ~file ~package typ =
constructors |> List.filter_map (fromConstructorPath ~env:envToSearch)

(* Produces a hover with relevant types expanded in the main type being hovered. *)
let hoverWithExpandedTypes ~docstring ~file ~package ~supportsMarkdownLinks typ
=
let hoverWithExpandedTypes ~file ~package ~supportsMarkdownLinks typ =
let typeString = Markdown.codeBlock (typ |> Shared.typeToString) in
let types = findRelevantTypesFromType typ ~file ~package in
let typeDefinitions =
Expand All @@ -114,7 +113,7 @@ let hoverWithExpandedTypes ~docstring ~file ~package ~supportsMarkdownLinks typ
(SharedTypes.pathIdentToString path))
^ linkToTypeDefinitionStr ^ "\n")
in
(typeString :: typeDefinitions |> String.concat "\n", docstring)
typeString :: typeDefinitions |> String.concat "\n"

(* Leverages autocomplete functionality to produce a hover for a position. This
makes it (most often) work with unsaved content. *)
Expand Down Expand Up @@ -151,12 +150,20 @@ let getHoverViaCompletions ~debug ~path ~pos ~currentFile ~forHover
@ docstring
in
Some (Protocol.stringifyHover (String.concat "\n\n" parts))
| {kind = Field _; docstring} :: _ -> (
match CompletionBackEnd.completionsGetTypeEnv completions with
| Some (typ, _env) ->
let typeString =
hoverWithExpandedTypes ~file ~package ~supportsMarkdownLinks typ
in
let parts = [typeString] @ docstring in
Some (Protocol.stringifyHover (String.concat "\n\n" parts))
| None -> None)
| _ -> (
match CompletionBackEnd.completionsGetTypeEnv completions with
| Some (typ, _env) ->
let typeString, _docstring =
hoverWithExpandedTypes ~docstring:"" ~file ~package
~supportsMarkdownLinks typ
let typeString =
hoverWithExpandedTypes ~file ~package ~supportsMarkdownLinks typ
in
Some (Protocol.stringifyHover typeString)
| None -> None))))
Expand Down Expand Up @@ -221,8 +228,8 @@ let newHover ~full:{file; package} ~supportsMarkdownLinks locItem =
| Const_nativeint _ -> "int"))
| Typed (_, t, locKind) ->
let fromType ~docstring typ =
hoverWithExpandedTypes ~docstring ~file ~package ~supportsMarkdownLinks
typ
( hoverWithExpandedTypes ~file ~package ~supportsMarkdownLinks typ,
docstring )
in
let parts =
match References.definedForLoc ~file ~package locKind with
Expand All @@ -234,7 +241,7 @@ let newHover ~full:{file; package} ~supportsMarkdownLinks locItem =
| `Declared ->
let typeString, docstring = t |> fromType ~docstring in
typeString :: docstring
| `Constructor {cname = {txt}; args} ->
| `Constructor {cname = {txt}; args; docstring} ->
let typeString, docstring = t |> fromType ~docstring in
let argsString =
match args with
Expand All @@ -244,7 +251,7 @@ let newHover ~full:{file; package} ~supportsMarkdownLinks locItem =
|> List.map (fun (t, _) -> Shared.typeToString t)
|> String.concat ", " |> Printf.sprintf "(%s)"
in
typeString :: Markdown.codeBlock (txt ^ argsString) :: docstring
[Markdown.codeBlock (txt ^ argsString)] @ docstring @ [typeString]
| `Field ->
let typeString, docstring = t |> fromType ~docstring in
typeString :: docstring)
Expand Down
25 changes: 25 additions & 0 deletions analysis/src/ProcessCmt.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ let rec forTypeSignatureItem ~(env : SharedTypes.Env.t) ~(exported : Exported.t)
| Cstr_record _ -> []);
res = cd_res;
typeDecl = (name, decl);
docstring =
(match
ProcessAttributes.findDocAttribute
cd_attributes
with
| None -> []
| Some docstring -> [docstring]);
}
in
let declared =
Expand All @@ -99,6 +106,12 @@ let rec forTypeSignatureItem ~(env : SharedTypes.Env.t) ~(exported : Exported.t)
optional =
Res_parsetree_viewer.hasOptionalAttribute
ld_attributes;
docstring =
(match
ProcessAttributes.findDocAttribute ld_attributes
with
| None -> []
| Some docstring -> [docstring]);
})));
}
~name ~stamp:(Ident.binding_time ident) ~env type_attributes
Expand Down Expand Up @@ -201,6 +214,12 @@ let forTypeDeclaration ~env ~(exported : Exported.t)
| None -> None
| Some t -> Some t.ctyp_type);
typeDecl = (name.txt, typ_type);
docstring =
(match
ProcessAttributes.findDocAttribute cd_attributes
with
| None -> []
| Some docstring -> [docstring]);
}
in
let declared =
Expand Down Expand Up @@ -230,6 +249,12 @@ let forTypeDeclaration ~env ~(exported : Exported.t)
optional =
Res_parsetree_viewer.hasOptionalAttribute
ld_attributes;
docstring =
(match
ProcessAttributes.findDocAttribute ld_attributes
with
| None -> []
| Some docstring -> [docstring]);
})));
}
~name ~stamp ~env typ_attributes
Expand Down
Loading