tree_sitter_jsdoc/
lib.rs

1//! This crate provides JSDoc 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//! /**
9//!   * This is a JSDoc comment
10//!   *
11//!   * @param {string} foo
12//!   */
13//! "#;
14//! let mut parser = tree_sitter::Parser::new();
15//! let language = tree_sitter_jsdoc::LANGUAGE;
16//! parser
17//!     .set_language(&language.into())
18//!     .expect("Error loading JSDoc parser");
19//! let tree = parser.parse(code, None).unwrap();
20//! assert!(!tree.root_node().has_error());
21//! ```
22//!
23//! [`Parser`]: https://docs.rs/tree-sitter/0.25.9/tree_sitter/struct.Parser.html
24//! [tree-sitter]: https://tree-sitter.github.io/
25
26use tree_sitter_language::LanguageFn;
27
28extern "C" {
29    fn tree_sitter_jsdoc() -> *const ();
30}
31
32/// The tree-sitter [`LanguageFn`] for this grammar.
33pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_jsdoc) };
34
35/// The content of the [`node-types.json`] file for this grammar.
36///
37/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
38pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
39
40/// The syntax highlighting query for this grammar.
41pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
42
43#[cfg(test)]
44mod tests {
45    #[test]
46    fn test_can_load_grammar() {
47        let mut parser = tree_sitter::Parser::new();
48        parser
49            .set_language(&super::LANGUAGE.into())
50            .expect("Error loading JSDoc parser");
51    }
52}
tree_sitter_jsdoc/lib.rs

tree_sitter_jsdoc/
lib.rs
