difftastic/vendored_parsers/tree-sitter-javascript/bindings/rust/README.md

47 lines
1.5 KiB
Markdown

# tree-sitter-javascript
This crate provides a JavaScript grammar for the [tree-sitter][] parsing
library. To use this crate, add it to the `[dependencies]` section of your
`Cargo.toml` file. (Note that you will probably also need to depend on the
[`tree-sitter`][tree-sitter crate] crate to use the parsed result in any useful
way.)
```toml
[dependencies]
tree-sitter = "~0.20.10"
tree-sitter-javascript = "~0.20.3"
```
Typically, you will use the [language][language func] function to add this
grammar to a tree-sitter [Parser][], and then use the parser to parse some code.
The below example demonstrates a simple program that parses a JavaScript
function and prints the result to your terminal.
```rust
use tree_sitter::Parser;
fn main() {
let code = r#"
function double(x) {
return x * 2;
}
"#;
let mut parser = Parser::new();
parser
.set_language(tree_sitter_javascript::language())
.expect("Error loading JavaScript grammar");
let parsed = parser.parse(code, None);
println!("{:#?}", parsed);
}
```
If you have any questions, please reach out to us in the [tree-sitter
discussions] page.
[language func]: https://docs.rs/tree-sitter-javascript/*/tree_sitter_javascript/fn.language.html
[Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
[tree-sitter]: https://tree-sitter.github.io/
[tree-sitter crate]: https://crates.io/crates/tree-sitter
[tree-sitter discussions]: https://github.com/tree-sitter/tree-sitter/discussions