Run tree-sitter queries on tree-sitter trees

Use tree-sitter's query language to find nodes in a tree-sitter tree.

Available tree-sitter parsers

This is the manual page of the ts_tree_query() S3 generic function. Methods in parser packages may override this generic. For the ones that do see the links to their manual pages in the table.

Package	Version	Title	Method
tsjsonc	0.0.0.9000	Edit JSON Files.	ts_tree_query(<ts_tree_tsjsonc>)
tstoml	0.0.0.9000	Edit TOML files.	ts_tree_query(<ts_tree_tstoml>)

Usage

ts_tree_query(tree, query)

Arguments

tree

A ts_tree object.

query

Character string, the tree-sitter query to run.

Value

A list with entries patterns and matched_captures.

patterns contains information about all patterns in the queries and it is a data frame with columns: id, name, pattern, match_count.

matched_captures contains information about all matches, and it has columns id, pattern, match, start_byte, end_byte, start_row, start_column, end_row, end_column, name, code.

The pattern column of matched_captured refers to the id column of patterns.

Details

You probably need to know some details about the specific tree-sitter parser you are using, to write effective queries. See the documentation of the parser package you are using for details about the node types and the query language support. See links below.

JSONC TOML

 

json <- tsjsonc::ts_parse_jsonc(
  '{ "a": 1, "b": [10, 20, 30], "c": { "c1": true, "c2": 100 } }'
)
json |> ts_tree_query("(number) @number")

#> $patterns
#> # A data frame: 1 × 4
#>      id name  pattern              match_count
#>   <int> <chr> <chr>                      <int>
#> 1     1 NA    "(number) @number\n"           5
#>
#> $captures
#> # A data frame: 1 × 2
#>      id name
#>   <int> <chr>
#> 1     1 number
#>
#> $matched_captures
#> # A data frame: 5 × 12
#>      id pattern match type  start_byte end_byte start_row start_column
#>   <int>   <int> <int> <chr>      <int>    <int>     <int>        <int>
#> 1     1       1     1 numb…          7        8         0            7
#> 2     1       1     2 numb…         16       18         0           16
#> 3     1       1     3 numb…         20       22         0           20
#> 4     1       1     4 numb…         24       26         0           24
#> 5     1       1     5 numb…         54       57         0           54
#> # ℹ 4 more variables: end_row <int>, end_column <int>, name <chr>,
#> #   code <chr>
#>

 

toml <- tstoml::ts_parse_toml(
  'a = 1\nb = [10.0, 20, 30]\nc = { c1 = true, c2 = 100 }'
)
toml |> ts_tree_query("[(float) (integer)] @number")

#> $patterns
#> # A data frame: 1 × 4
#>      id name  pattern                         match_count
#>   <int> <chr> <chr>                                 <int>
#> 1     1 NA    "[(float) (integer)] @number\n"           5
#>
#> $captures
#> # A data frame: 1 × 2
#>      id name
#>   <int> <chr>
#> 1     1 number
#>
#> $matched_captures
#> # A data frame: 5 × 12
#>      id pattern match type    start_byte end_byte start_row start_column end_row
#>   <int>   <int> <int> <chr>        <int>    <int>     <int>        <int>   <int>
#> 1     1       1     1 integer          4        5         0            4       0
#> 2     1       1     2 float           11       15         1            5       1
#> 3     1       1     3 integer         17       19         1           11       1
#> 4     1       1     4 integer         21       23         1           15       1
#> 5     1       1     5 integer         47       50         2           22       2
#> # ℹ 3 more variables: end_column <int>, name <chr>, code <chr>
#>

See also

ts_tree_select() to select the nodes matching a query.

Methods in installed packages: ts_tree_query(<ts_tree_tsjsonc>) and ts_tree_query(<ts_tree_tstoml>).

Other ts_tree exploration: ts_tree-brackets, ts_tree_ast(), ts_tree_dom(), ts_tree_sexpr()

Other ts_tree generics: [[.ts_tree(), [[<-.ts_tree(), format.ts_tree(), print.ts_tree(), select-set, ts_tree_ast(), ts_tree_delete(), ts_tree_dom(), ts_tree_format(), ts_tree_insert(), ts_tree_new(), ts_tree_select(), ts_tree_sexpr(), ts_tree_unserialize(), ts_tree_update(), ts_tree_write()

Examples

# Select all numbers in a JSONC document ------------------------------------
json <- tsjsonc::ts_parse_jsonc(
  '{ "a": 1, "b": [10, 20, 30], "c": { "c1": true, "c2": 100 } }'
)
json |> ts_tree_query("(number) @number")
#> $patterns
#> # A data frame: 1 × 4
#>      id name  pattern              match_count
#>   <int> <chr> <chr>                      <int>
#> 1     1 NA    "(number) @number\n"           5
#> 
#> $captures
#> # A data frame: 1 × 2
#>      id name  
#>   <int> <chr> 
#> 1     1 number
#> 
#> $matched_captures
#> # A data frame: 5 × 12
#>      id pattern match type   start_byte end_byte start_row start_column
#>   <int>   <int> <int> <chr>       <int>    <int>     <int>        <int>
#> 1     1       1     1 number          7        8         0            7
#> 2     1       1     2 number         16       18         0           16
#> 3     1       1     3 number         20       22         0           20
#> 4     1       1     4 number         24       26         0           24
#> 5     1       1     5 number         54       57         0           54
#> # ℹ 4 more variables: end_row <int>, end_column <int>, name <chr>,
#> #   code <chr>
#>