6 releases (3 breaking)
0.6.0 | Nov 30, 2024 |
---|---|
0.5.3 | Nov 25, 2024 |
0.5.2 | Oct 20, 2024 |
0.4.0 | Apr 1, 2024 |
0.3.0 | Jul 18, 2023 |
#682 in Parser implementations
620 downloads per month
Used in 2 crates
(via type-sitter-lib)
56KB
1K
SLoC
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
Custom
data 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.
TreeCursor
is split intoLocalTreeCursor
andGlobalTreeCursor
. WhenGlobalTreeCursor
is reset to a node it can still go to parents and siblings, albeit with a performance penalty.LocalTreeCursor
is the originalTreeCursor
since 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
Dependencies
~3–4MB
~80K SLoC