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