Tree-sitter Questions

Some tree-sitter-related questions with discussions and some answers.

• What Paths are Relevant for tree-sitter Use?

• What Files Are Involved in tree-sitter generate?

• Should Generated Parser Source Be Committed?

• What ABI Version Should Be Used for parser.c?

• Are External Scanners Commonly Used?

• What Regular Expression Features Are Supported?

• Which Version of Emscripten Should be Used for the Playground?

• How Can a Custom Playground Be Hosted?

• How Can One Test for An Expected Error?

• Is There Some Way to Influence Error Recovery?

• Is There A Changelog?

• What Are Some Projects That Use Tree-sitter?

Prerequisites for Scripts

There are some scripts in this repository with these prerequisites:

• git
• janet

Assuming those things are in place, clone this repository:

git clone https://github.com/sogaiu/ts-questions

The scripts that involve generating statistics across multiple repositories assume that parser / grammar repositories have been fetched to live under a repos subdirectory.

The repos directory can be populated by running the following script from this project's root directory:

janet ./script/fetch-repositories.janet

The list of repositories to fetch is determined via the file ts-grammar-repositories.txt.

Repositories within repos can be updated by using the following invocation in a manner analogous to the fetching one:

janet ./script/update-repositories.janet

This might be useful if one was interested in up-to-date statistics.

Breaking Change

The scripts in this repository used to be shell scripts, but this was becoming unwieldy and awkward to maintain. Most of them have been removed but the scripts for fetching and updating repositories still exist in the script subdirectory.

These remaining shell scripts can still be used for fetching and updating repositories, but they don't play well with the statistics-generating .janet scripts.

Credits

• ahelwer
• ahlinc
• amaanq
• clason and nvim-treesitter contributors
• damieng
• dannyfreeman
• NoahTheDuke