codebook_tree_sitter_typst/lib.rs
1//! This crate provides typst language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [language][language func] function 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//! return 42
9//! "#;
10//! let mut parser = tree_sitter::Parser::new();
11//! let language = codebook_tree_sitter_typst::LANGUAGE;
12//! parser
13//! .set_language(&language.into())
14//! .expect("Error loading Typst parser");
15//! let tree = parser.parse(code, None).unwrap();
16//! assert!(!tree.root_node().has_error());
17//! ```
18//!
19//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
20//! [language func]: fn.language.html
21//! [Parser]: https://docs.rs/tree-sitter/*/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_typst() -> *const ();
28}
29
30/// The tree-sitter [`LanguageFn`] for this grammar.
31pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_typst) };
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#[cfg(test)]
39mod tests {
40 #[test]
41 fn test_can_load_grammar() {
42 let mut parser = tree_sitter::Parser::new();
43 parser
44 .set_language(&super::LANGUAGE.into())
45 .expect("Error loading Typst parser");
46 }
47}