Tree-sitter: Documentation about tree node fields

[fwcd]

There are several grammars that use a field(...)-function to produce labelled syntax tree nodes, including Java and JS. The Grammar DSL docs do not mention it, however.

Am I missing something?

[issue-label-bot[bot]]

Issue Label Bot is not confident enough to auto-label this issue. See dashboard for more details.

[maxbrunsfeld]

Yeah, I have a lot of documentation to write, after the last several months of changes. I guess I was waiting to write the docs until I've been using the feature internally for a while to get all of the problems worked out.

But it's pretty much done. So in the meantime, here's some info:

• The concept was introduced in https://github.com/tree-sitter/tree-sitter/pull/271.
• The only change to the Grammar API is the new field function which you pointed out.
• The new C library APIs for dealing with fields are here and here.
• If you're using the Node.js binding, its new APIs are described here.
• If you're using the Rust binding, the new APIs are here and here.

[fwcd]

@maxbrunsfeld Thanks for the quick response and the links!

[Razzeee]

As far as I can tell wasm only has field name? https://github.com/tree-sitter/tree-sitter/blame/master/lib/binding_web/tree-sitter-web.d.ts#L100

Will we get the id (no idea what's that for) and the child by field name function too?

[maxbrunsfeld]

Will we get the id (no idea what's that for) and the child by field name function too?

Yeah, I added the remaining bindings in https://github.com/tree-sitter/tree-sitter/commit/82fab90c0b91cc57a949b9d96768d7f3b7a621e4.

[maxbrunsfeld]

Docs are up: here: http://tree-sitter.github.io/tree-sitter/using-parsers#node-field-names and here: http://tree-sitter.github.io/tree-sitter/creating-parsers#using-fields.