tree-sitter-grammars

Repository containing tree-sitter grammars for many different languages available in one place, and a small CLI utility to add and update grammars.

Usage & Development

Command line program to add and update tree-sitter grammars for different languages.

Usage: tree-sitter-grammars [OPTIONS] [COMMAND]

Commands:
  add    Add a new tree-sitter grammar to the `languages.toml` file
  fetch  Fetch the tree-sitter grammar(s)
  help   Print this message or the help of the given subcommand(s)

Options:
  -f, --file <FILE>            Path to file containing languages and their grammar repositories [default: ./languages.toml]
  -d, --directory <DIRECTORY>  Path to directory containing grammar repositories [default: ./grammars/]
  -h, --help                   Print help
  -V, --version                Print version

If you have nix installed you can simply run nix build, or alternatively use the development shell with nix develop and then run cargo build.

Contributing

If you'd like to add an additional language, please open a PR after following the instructions in Adding a new grammar. Please take note the following conventions:

• Test the new grammar to make sure the parser is functional
• Replace an existing grammar only if the new grammar is more complete or better maintained
• Add a hash only if necessary (i.e. the latest commit is broken)

Adding a new grammar

All languages are listed out in the languages.toml file and are downloaded to the grammars directory by default using the accompanying Rust program. To add a new language, modify the languages.toml file to include:

tree-sitter-grammars add --name foo \
                         --git https://github.com/user/tree-sitter-foo.git \
                         --hash 04937885edaae68e9b52001b88a6f72daeda391e \

Once added to the languages.toml file, the program will also download the grammar from the repository.

Updating all grammars

All listed grammars can be updated to their latest versions by running:

tree-sitter-grammars fetch --all

Take note of the --all flag. Alternatively, a single grammar is updated by providing the --name flag along with the language to be updated.

License

Mozilla Public License, v. 2.0. See LICENSE.

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.

NOTE: each grammar under /grammars/tree-sitter-<language> has it's own LICENSE, which is kept at the root. Please consult the individual licenses for each grammar as well.