tree_sitter_javascript_sg/
lib.rs

1//! This crate provides a JavaScript grammar for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [language][language func] function to add this grammar to a
4//! tree-sitter [Parser][], and then use the parser to parse some code:
5//!
6//! ```
7//! use tree_sitter::Parser;
8//!
9//! let code = r#"
10//! function double(x) {
11//!     return x * 2;
12//! }
13//! "#;
14//! let mut parser = Parser::new();
15//! parser.set_language(&tree_sitter_javascript::language()).expect("Error loading JavaScript grammar");
16//! let tree = parser.parse(code, None).unwrap();
17//! assert!(!tree.root_node().has_error());
18//! ```
19//!
20//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
21//! [language func]: fn.language.html
22//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
23//! [tree-sitter]: https://tree-sitter.github.io/
24
25use tree_sitter::Language;
26
27extern "C" {
28    fn tree_sitter_javascript() -> Language;
29}
30
31/// Returns the tree-sitter [Language][] for this grammar.
32///
33/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
34pub fn language() -> Language {
35    unsafe { tree_sitter_javascript() }
36}
37
38/// The content of the [`node-types.json`][] file for this grammar.
39///
40/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
41pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
42
43/// The syntax highlighting query for this language.
44pub const HIGHLIGHT_QUERY: &str = include_str!("../../queries/highlights.scm");
45
46/// The syntax highlighting query for languages injected into this one.
47pub const INJECTIONS_QUERY: &str = include_str!("../../queries/injections.scm");
48
49/// The syntax highlighting query for JSX.
50pub const JSX_HIGHLIGHT_QUERY: &str = include_str!("../../queries/highlights-jsx.scm");
51
52/// The local-variable syntax highlighting query for this language.
53pub const LOCALS_QUERY: &str = include_str!("../../queries/locals.scm");
54
55/// The symbol tagging query for this language.
56pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
57
58#[cfg(test)]
59mod tests {
60    #[test]
61    fn can_load_grammar() {
62        let mut parser = tree_sitter::Parser::new();
63        parser
64            .set_language(&super::language())
65            .expect("Error loading JavaScript grammar");
66    }
67}