yak-sitter: opinionated tree-sitter facade which lets you store data visible to nodes and provides other improvements
This library provides an API almost identical to tree-sitter, but with the following changes:
- Trees can optionally store
Customdata of arbitrary type, which each node can access via shared reference. Typically the custom data will contain a map of nodes to additional metadata, or a diagnostic logger (assuming all diagnostics have at least one source location). Then, you won't need to pass around this extra information to functions which deal with nodes, you can retrieve it from the nodes directly. - Trees store their original source code, and nodes can access their text
- Trees also store the path they were parsed from, and nodes can access this path
- Nodes are ordered based on their location in the tree, and nodes from different trees are ordered based on their paths.
TreeCursoris split intoLocalTreeCursorandGlobalTreeCursor. WhenGlobalTreeCursoris reset to a node it can still go to parents and siblings, albeit with a performance penalty.LocalTreeCursoris the originalTreeCursorsince its behavior a bit confusing.- All parsed text must be valid UTF-8
The library is an attempt to integrate tree-sitter with an existing project (https://github.com/Jakobeha/nominalscript), hence the name. Regardless, if you want any changes or have any suggestions, feel free to submit a github issue or PR