traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tree-sitter/cli
History
Patrick Thomson f5d1c0b860 Support @module as a highlight key. 
Some languages have the notion of modules, and to represent those
we've started to use a `@module` tag, as discussed in
https://github.com/elixir-lang/tree-sitter-elixir/issues/15.
Because historically we've used the constructor highlight color for
modules in JS/Ruby, it's defined to map to the same color.
2021-12-15 17:33:57 -05:00
..
benches cli: Extract CLI configuration into separate crate 2021-06-10 10:21:22 -04:00
config Use serde's derive feature everywhere 2021-11-21 13:39:30 -08:00
loader loader: 0.20.0 2021-11-21 13:40:33 -08:00
npm 0.20.1 2021-11-21 12:33:27 -08:00
src Support @module as a highlight key. 2021-12-15 17:33:57 -05:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs Put emscripten-version file in cli directory 2021-09-03 13:57:45 -07:00
Cargo.toml Update loader dependency in cli 2021-11-21 13:56:22 -08:00
emscripten-version Put emscripten-version file in cli directory 2021-09-03 13:57:45 -07:00
README.md chore(docs): Fix misprints 2021-09-22 00:24:36 +03:00

README.md

Tree-sitter CLI

Build Status Build status Crates.io

The Tree-sitter CLI allows you to develop, test, and use Tree-sitter grammars from the command line. It works on MacOS, Linux, and Windows.

Installation

You can install the tree-sitter-cli with cargo:

cargo install tree-sitter-cli

or with npm:

npm install tree-sitter-cli

You can also download a pre-built binary for your platform from the releases page.

Dependencies

The tree-sitter binary itself has no dependencies, but specific commands have dependencies that must be present at runtime:

  • To generate a parser from a grammar, you must have node on your PATH.
  • To run and test parsers, you must have a C and C++ compiler on your system.

Commands

  • generate - The tree-sitter generate command will generate a Tree-sitter parser based on the grammar in the current working directory. See the documentation for more information.

  • test - The tree-sitter test command will run the unit tests for the Tree-sitter parser in the current working directory. See the documentation for more information.

  • parse - The tree-sitter parse command will parse a file (or list of files) using Tree-sitter parsers.