traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: document the @ignore capture in tags

Browse source
This commit is contained in:
Amaan Qureshi 2025-09-14 06:25:03 -04:00 • committed by Amaan Qureshi
parent 3a911d578c
commit 4dbfb5b49a
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/src/3-syntax-highlighting.md
View file

@ -180,6 +180,9 @@ The capture names are as follows:
- `@local.reference` — indicates that a syntax node contains the *name*, which *may* refer to an earlier definition within
some enclosing scope.
Additionally, to ignore certain nodes from being tagged, you can use the `@ignore` capture. This is useful if you want
to run a predicate or directive on a node, but don't want it to be tagged.
When highlighting a file, Tree-sitter will keep track of the set of scopes that contains any given position, and the set
of definitions within each scope. When processing a syntax node that is captured as a `local.reference`, Tree-sitter will
try to find a definition for a name that matches the node's text. If it finds a match, Tree-sitter will ensure that the