Skip to content
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

Create interface file: add support for JSX V4. #580

Merged
merged 2 commits into from
Sep 10, 2022
Merged

Create interface file: add support for JSX V4. #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1a0ee9
Create interface file: add support for JSX V4.
cristianoc Sep 10, 2022
9632715
Update CHANGELOG.md
cristianoc Sep 10, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#### :rocket: New Feature

- Add support for prop completion for JSX V4 https://github.com/rescript-lang/rescript-vscode/pull/579
- Add support for create interface file for JSX V4 https://github.com/rescript-lang/rescript-vscode/pull/580

## v1.6.0

Expand Down
83 changes: 80 additions & 3 deletions analysis/src/CreateInterface.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ let printSignature ~extractor ~signature =

let buf = Buffer.create 10 in

let getComponentType (typ : Types.type_expr) =
let getComponentTypeV3 (typ : Types.type_expr) =
let reactElement =
Ctype.newconstr (Pdot (Pident (Ident.create "React"), "element", 0)) []
in
Expand All @@ -183,6 +183,29 @@ let printSignature ~extractor ~signature =
| _ -> None
in

let getComponentTypeV4 (typ : Types.type_expr) =
let reactElement =
Ctype.newconstr (Pdot (Pident (Ident.create "React"), "element", 0)) []
in
match typ.desc with
| Tarrow (_, {desc = Tconstr (Path.Pident propsId, typeArgs, _)}, retType, _)
when Ident.name propsId = "props" ->
Some (typeArgs, retType)
| Tconstr
( Pdot (Pident {name = "React"}, "component", _),
[{desc = Tconstr (Path.Pident propsId, typeArgs, _)}],
_ )
when Ident.name propsId = "props" ->
Some (typeArgs, reactElement)
| Tconstr
( Pdot (Pident {name = "React"}, "componentLike", _),
[{desc = Tconstr (Path.Pident propsId, typeArgs, _)}; retType],
_ )
when Ident.name propsId = "props" ->
Some (typeArgs, retType)
| _ -> None
in

let rec processSignature ~indent (signature : Types.signature) : unit =
match signature with
| Sig_value
Expand All @@ -193,14 +216,14 @@ let printSignature ~extractor ~signature =
when Ident.name makePropsId = Ident.name makeId ^ "Props"
&& ((* from implementation *) makePropsLoc.loc_ghost
|| (* from interface *) makePropsLoc = makeValueDesc.val_loc)
&& getComponentType makeValueDesc.val_type <> None ->
&& getComponentTypeV3 makeValueDesc.val_type <> None ->
(*
{"name": string} => retType ~~> (~name:string) => retType
React.component<{"name": string}> ~~> (~name:string) => React.element
React.componentLike<{"name": string}, retType> ~~> (~name:string) => retType
*)
let tObj, retType =
match getComponentType makeValueDesc.val_type with
match getComponentTypeV3 makeValueDesc.val_type with
| None -> assert false
| Some (tObj, retType) -> (tObj, retType)
in
Expand All @@ -213,6 +236,60 @@ let printSignature ~extractor ~signature =
Buffer.add_string buf (indent ^ "@react.component\n");
Buffer.add_string buf (indent ^ newItemStr ^ "\n");
processSignature ~indent rest
| Sig_type
( propsId,
{
type_params;
type_kind = Type_record (labelDecls, Record_optional_labels optLbls);
},
_ )
:: Sig_value (makeId (* make *), makeValueDesc)
:: rest
when Ident.name propsId = "props"
&& getComponentTypeV4 makeValueDesc.val_type <> None
&& optLbls |> List.mem "key" ->
(* PPX V4 component declaration:
type props = {..., key?: _}
let v = ...
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a heuristic.
Can't be super precise when working with the results of running a PPX.

*)
let newItemStr =
let typeArgs, retType =
match getComponentTypeV4 makeValueDesc.val_type with
| Some x -> x
| None -> assert false
in
let rec mkFunType (labelDecls : Types.label_declaration list) =
match labelDecls with
| [] -> retType
| labelDecl :: rest ->
let propType =
CompletionBackEnd.instantiateType ~typeParams:type_params
~typeArgs labelDecl.ld_type
in
let lblName = labelDecl.ld_id |> Ident.name in
let lbl =
if List.mem lblName optLbls then Asttypes.Optional lblName
else Labelled lblName
in
if lblName = "key" then mkFunType rest
else
{retType with desc = Tarrow (lbl, propType, mkFunType rest, Cok)}
in
let funType =
if List.length labelDecls = 1 (* No props: only "key "*) then
let tUnit =
Ctype.newconstr (Path.Pident (Ident.create "unit")) []
in
{retType with desc = Tarrow (Nolabel, tUnit, retType, Cok)}
else mkFunType labelDecls
in
sigItemToString
(Printtyp.tree_of_value_description makeId
{makeValueDesc with val_type = funType})
in
Buffer.add_string buf (indent ^ "@react.component\n");
Buffer.add_string buf (indent ^ newItemStr ^ "\n");
processSignature ~indent rest
| Sig_module (id, modDecl, recStatus) :: rest ->
let colonOrEquals =
match modDecl.md_type with
Expand Down
2 changes: 1 addition & 1 deletion analysis/vendor/compiler-libs-406/includecore.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ let type_declarations ?(equality = false) ~loc env name decl1 id decl2 =
let err = compare_records ~loc env decl1.type_params decl2.type_params
1 labels1 labels2 in
if err <> [] || rep1 = rep2 then err else
[Record_representation (rep2 = Record_float)]
[Record_representation (rep2 = Record_float_unused)]
| (Type_open, Type_open) -> []
| (_, _) -> [Kind]
in
Expand Down
6 changes: 3 additions & 3 deletions analysis/vendor/compiler-libs-406/typecore.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,7 +780,7 @@ module Label = NameChoice (struct
let unbound_name_error = Typetexp.unbound_label_error
let in_env lbl =
match lbl.lbl_repres with
| Record_regular | Record_float | Record_unboxed false -> true
| Record_regular | Record_optional_labels _ | Record_float_unused | Record_unboxed false -> true
| Record_unboxed true | Record_inlined _ | Record_extension -> false
end)

Expand Down Expand Up @@ -2015,9 +2015,9 @@ struct
| Texp_record { fields = es; extended_expression = eo;
representation = rep } ->
let use = match rep with
| Record_float -> Use.inspect
| Record_float_unused -> Use.inspect
| Record_unboxed _ -> (fun x -> x)
| Record_regular | Record_inlined _
| Record_regular | Record_optional_labels _ | Record_inlined _
| Record_extension -> Use.guard
in
let field env = function
Expand Down
2 changes: 1 addition & 1 deletion analysis/vendor/compiler-libs-406/typedecl.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ let transl_declaration env sdecl id =
let rep =
if unbox then Record_unboxed false
else if List.for_all (fun l -> is_float env l.Types.ld_type) lbls'
then Record_float
then Record_float_unused
else Record_regular
in
Ttype_record lbls, Type_record(lbls', rep)
Expand Down
13 changes: 7 additions & 6 deletions analysis/vendor/compiler-libs-406/types.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,12 @@ and type_kind =
| Type_open

and record_representation =
Record_regular (* All fields are boxed / tagged *)
| Record_float (* All fields are floats *)
| Record_unboxed of bool (* Unboxed single-field record, inlined or not *)
| Record_inlined of int (* Inlined record *)
| Record_extension (* Inlined record under extension *)
| Record_regular (* All fields are boxed / tagged *)
| Record_float_unused (* Was: all fields are floats. Now: unused *)
| Record_unboxed of bool (* Unboxed single-field record, inlined or not *)
| Record_inlined of int (* Inlined record *)
| Record_extension (* Inlined record under extension *)
| Record_optional_labels of string list (* List of optional labels *)

and label_declaration =
{
Expand Down Expand Up @@ -346,4 +347,4 @@ type label_description =
lbl_private: private_flag; (* Read-only field? *)
lbl_loc: Location.t;
lbl_attributes: Parsetree.attributes;
}
}
11 changes: 6 additions & 5 deletions analysis/vendor/compiler-libs-406/types.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,11 +305,12 @@ and type_kind =
| Type_open

and record_representation =
Record_regular (* All fields are boxed / tagged *)
| Record_float (* All fields are floats *)
| Record_unboxed of bool (* Unboxed single-field record, inlined or not *)
| Record_inlined of int (* Inlined record *)
| Record_extension (* Inlined record under extension *)
| Record_regular (* All fields are boxed / tagged *)
| Record_float_unused (* Was: all fields are floats. Now: unused *)
| Record_unboxed of bool (* Unboxed single-field record, inlined or not *)
| Record_inlined of int (* Inlined record *)
| Record_extension (* Inlined record under extension *)
| Record_optional_labels of string list (* List of optional labels *)

and label_declaration =
{
Expand Down