Skip to content

Commit

Permalink
[indexed-access] Indexed Access parsing
Browse files Browse the repository at this point in the history 
Summary: Parsing for Indexed Access (`$ElementType<T, K>` -> `T[K]`).

Reviewed By: Hans-Halverson

Differential Revision: D26317267

fbshipit-source-id: 0d31965d58780970ed31efb40733568b81d96dfb
  • Loading branch information
@gkz @facebook-github-bot
gkz authored and facebook-github-bot committed Feb 12, 2021
1 parent ab410b1 commit f493122
Show file tree
Hide file tree
Showing 4 changed files with 295 additions and 4 deletions.
6 changes: 6 additions & 0 deletions packages/flow-parser/test/custom_ast_types.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export default function (fork) {
def("ObjectTypeIndexer")
.field("id", or(def("Identifier"), null));

def("IndexedAccessType")
.bases("FlowType")
.build("objectType", "indexType")
.field("objectType", def("FlowType"))
.field("indexType", def("FlowType"));

// See https://github.com/benjamn/ast-types/issues/180
def("ExportNamedDeclaration")
// TODO: this is non-standard, upstream is standard
Expand Down
9 changes: 9 additions & 0 deletions src/parser/test/flow/types/indexed_access/indexed_access.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
type A = Obj['a'];

type B = Array<string>[number];

type C = Obj['bar'][foo]['boz'];

type D = (Obj['bar'])['baz'];

type E = Obj['bar'][];
265 changes: 265 additions & 0 deletions src/parser/test/flow/types/indexed_access/indexed_access.tree.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
{
"type":"Program",
"loc":{"source":null,"start":{"line":1,"column":0},"end":{"line":9,"column":22}},
"range":[0,140],
"body":[
{
"type":"TypeAlias",
"loc":{"source":null,"start":{"line":1,"column":0},"end":{"line":1,"column":18}},
"range":[0,18],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":1,"column":5},"end":{"line":1,"column":6}},
"range":[5,6],
"name":"A",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null,
"right":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":1,"column":9},"end":{"line":1,"column":17}},
"range":[9,17],
"objectType":{
"type":"GenericTypeAnnotation",
"loc":{"source":null,"start":{"line":1,"column":9},"end":{"line":1,"column":12}},
"range":[9,12],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":1,"column":9},"end":{"line":1,"column":12}},
"range":[9,12],
"name":"Obj",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null
},
"indexType":{
"type":"StringLiteralTypeAnnotation",
"loc":{"source":null,"start":{"line":1,"column":13},"end":{"line":1,"column":16}},
"range":[13,16],
"value":"a",
"raw":"'a'"
}
}
},
{
"type":"TypeAlias",
"loc":{"source":null,"start":{"line":3,"column":0},"end":{"line":3,"column":31}},
"range":[20,51],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":3,"column":5},"end":{"line":3,"column":6}},
"range":[25,26],
"name":"B",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null,
"right":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":3,"column":9},"end":{"line":3,"column":30}},
"range":[29,50],
"objectType":{
"type":"GenericTypeAnnotation",
"loc":{"source":null,"start":{"line":3,"column":9},"end":{"line":3,"column":22}},
"range":[29,42],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":3,"column":9},"end":{"line":3,"column":14}},
"range":[29,34],
"name":"Array",
"typeAnnotation":null,
"optional":false
},
"typeParameters":{
"type":"TypeParameterInstantiation",
"loc":{"source":null,"start":{"line":3,"column":14},"end":{"line":3,"column":22}},
"range":[34,42],
"params":[
{
"type":"StringTypeAnnotation",
"loc":{"source":null,"start":{"line":3,"column":15},"end":{"line":3,"column":21}},
"range":[35,41]
}
]
}
},
"indexType":{
"type":"NumberTypeAnnotation",
"loc":{"source":null,"start":{"line":3,"column":23},"end":{"line":3,"column":29}},
"range":[43,49]
}
}
},
{
"type":"TypeAlias",
"loc":{"source":null,"start":{"line":5,"column":0},"end":{"line":5,"column":32}},
"range":[53,85],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":5,"column":5},"end":{"line":5,"column":6}},
"range":[58,59],
"name":"C",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null,
"right":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":5,"column":9},"end":{"line":5,"column":31}},
"range":[62,84],
"objectType":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":5,"column":9},"end":{"line":5,"column":24}},
"range":[62,77],
"objectType":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":5,"column":9},"end":{"line":5,"column":19}},
"range":[62,72],
"objectType":{
"type":"GenericTypeAnnotation",
"loc":{"source":null,"start":{"line":5,"column":9},"end":{"line":5,"column":12}},
"range":[62,65],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":5,"column":9},"end":{"line":5,"column":12}},
"range":[62,65],
"name":"Obj",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null
},
"indexType":{
"type":"StringLiteralTypeAnnotation",
"loc":{"source":null,"start":{"line":5,"column":13},"end":{"line":5,"column":18}},
"range":[66,71],
"value":"bar",
"raw":"'bar'"
}
},
"indexType":{
"type":"GenericTypeAnnotation",
"loc":{"source":null,"start":{"line":5,"column":20},"end":{"line":5,"column":23}},
"range":[73,76],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":5,"column":20},"end":{"line":5,"column":23}},
"range":[73,76],
"name":"foo",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null
}
},
"indexType":{
"type":"StringLiteralTypeAnnotation",
"loc":{"source":null,"start":{"line":5,"column":25},"end":{"line":5,"column":30}},
"range":[78,83],
"value":"boz",
"raw":"'boz'"
}
}
},
{
"type":"TypeAlias",
"loc":{"source":null,"start":{"line":7,"column":0},"end":{"line":7,"column":29}},
"range":[87,116],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":7,"column":5},"end":{"line":7,"column":6}},
"range":[92,93],
"name":"D",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null,
"right":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":7,"column":10},"end":{"line":7,"column":28}},
"range":[97,115],
"objectType":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":7,"column":10},"end":{"line":7,"column":20}},
"range":[97,107],
"objectType":{
"type":"GenericTypeAnnotation",
"loc":{"source":null,"start":{"line":7,"column":10},"end":{"line":7,"column":13}},
"range":[97,100],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":7,"column":10},"end":{"line":7,"column":13}},
"range":[97,100],
"name":"Obj",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null
},
"indexType":{
"type":"StringLiteralTypeAnnotation",
"loc":{"source":null,"start":{"line":7,"column":14},"end":{"line":7,"column":19}},
"range":[101,106],
"value":"bar",
"raw":"'bar'"
}
},
"indexType":{
"type":"StringLiteralTypeAnnotation",
"loc":{"source":null,"start":{"line":7,"column":22},"end":{"line":7,"column":27}},
"range":[109,114],
"value":"baz",
"raw":"'baz'"
}
}
},
{
"type":"TypeAlias",
"loc":{"source":null,"start":{"line":9,"column":0},"end":{"line":9,"column":22}},
"range":[118,140],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":9,"column":5},"end":{"line":9,"column":6}},
"range":[123,124],
"name":"E",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null,
"right":{
"type":"ArrayTypeAnnotation",
"loc":{"source":null,"start":{"line":9,"column":9},"end":{"line":9,"column":21}},
"range":[127,139],
"elementType":{
"type":"IndexedAccessType",
"loc":{"source":null,"start":{"line":9,"column":9},"end":{"line":9,"column":19}},
"range":[127,137],
"objectType":{
"type":"GenericTypeAnnotation",
"loc":{"source":null,"start":{"line":9,"column":9},"end":{"line":9,"column":12}},
"range":[127,130],
"id":{
"type":"Identifier",
"loc":{"source":null,"start":{"line":9,"column":9},"end":{"line":9,"column":12}},
"range":[127,130],
"name":"Obj",
"typeAnnotation":null,
"optional":false
},
"typeParameters":null
},
"indexType":{
"type":"StringLiteralTypeAnnotation",
"loc":{"source":null,"start":{"line":9,"column":13},"end":{"line":9,"column":18}},
"range":[131,136],
"value":"bar",
"raw":"'bar'"
}
}
}
}
],
"comments":[]
}
19 changes: 15 additions & 4 deletions src/parser/type_parser.ml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,21 @@ module Type (Parse : Parser_common.PARSER) : TYPE = struct
with_loc
~start_loc:(fst t)
(fun env ->
Expect.token env T_RBRACKET;
let trailing = Eat.trailing_comments env in
Type.Array
{ Type.Array.argument = t; comments = Flow_ast_utils.mk_comments_opt ~trailing () })
if Eat.maybe env T_RBRACKET then
(* Legacy Array syntax `T[]` <-> `Array<T>` *)
let trailing = Eat.trailing_comments env in
Type.Array
{ Type.Array.argument = t; comments = Flow_ast_utils.mk_comments_opt ~trailing () }
else
let index = _type env in
Expect.token env T_RBRACKET;
let trailing = Eat.trailing_comments env in
Type.IndexedAccess
{
Type.IndexedAccess._object = t;
index;
comments = Flow_ast_utils.mk_comments_opt ~trailing ();
})
env
in
postfix_with env t
Expand Down

0 comments on commit f493122

Please sign in to comment.