Interface Tree

ReadonlyrootNode

edit

• edit(edit: Edit): Tree

  Edit the syntax tree to keep it in sync with source code that has been edited. The edit must be described both in terms of byte offsets and in terms of row/column coordinates.

  Parameters

  • edit: Edit

    The edit to apply to the tree

  Returns Tree

  The edited tree

getChangedRanges

• getChangedRanges(other: Tree): Range[]

  Compare this edited syntax tree to a new syntax tree representing the same document, returning ranges whose syntactic structure has changed.

  For this to work correctly, this tree must have been edited to match the new tree's ranges. Generally, you'll want to call this right after parsing, using the old tree that was passed to parse and the new tree that was returned.

  Parameters

  • other: Tree

    The new tree to compare against

  Returns Range[]

  Array of ranges that have changed

getEditedRange

• getEditedRange(): Range

  Get the range that was edited in this tree

  Returns Range

  The edited range

getIncludedRanges

• getIncludedRanges(): Range[]

  Get the ranges that were included when parsing this syntax tree

  Returns Range[]

  Array of included ranges

getText

• getText(node: SyntaxNode): string

  Get the text for a node within this tree

  Parameters

  • node: SyntaxNode

    The syntax node to get text for

  Returns string

  The source text for the node

printDotGraph

• printDotGraph(fd?: number): void

  Print a graph of the tree in the DOT language. You may want to pipe this to a 'dot' process to generate SVG output.

  Parameters

  • Optionalfd: number

    Optional file descriptor for the output

  Returns void

rootNodeWithOffset

• rootNodeWithOffset(offsetBytes: number, offsetExtent: Point): SyntaxNode

  Get the root node of the syntax tree, but with its position shifted forward by the given offset.

  Parameters

  • offsetBytes: number

    The number of bytes to shift by

  • offsetExtent: Point

    The number of rows/columns to shift by

  Returns SyntaxNode

  The root node with its position offset

walk

• walk(): TreeCursor

  Create a new TreeCursor starting from the root of the tree.

  Returns TreeCursor

  A new cursor positioned at the root node