libs-code/tree-sitter.tree-sitter
1
0
Fork 0
mirror of https://github.com/tree-sitter/tree-sitter.git synced 2026-09-10 07:26:23 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add docs section about hidden rules

Browse source
This commit is contained in:
Max Brunsfeld 2018-03-05 09:35:52 -08:00
parent 60eacbc7ff
commit daf2c01d8b
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/creating-parsers.md
View file

@ -327,6 +327,10 @@ binary_expression: $ => choice(
),
```
### Hiding rules
You may have noticed in the above examples that some of the grammar rule name like `_expression` and `_type` began with an underscore. Starting a rule's name with an underscore causes the rule to be *hidden* in the syntax tree. This is useful for rules like `_expression` in the grammars above, which always just wrap a single child node. If these nodes were not hidden, they would add substantial depth and noise to the syntax tree without making it any easier to understand.
## Dealing with LR conflicts
[cst]: https://en.wikipedia.org/wiki/Parse_tree