tree_sitter_gitcommit/lib.rs
1//! This crate provides gitcommit 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 = "";
8//! let mut parser = tree_sitter::Parser::new();
9//! let language = tree_sitter_gitcommit::LANGUAGE;
10//! parser
11//! .set_language(&language.into())
12//! .expect("Error loading gitcommit grammar");
13//! let tree = parser.parse(code, None).unwrap();
14//! ```
15//!
16//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
17//! [LANGUAGE]: constant.LANGUAGE.html
18//! [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
19//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
20//! [tree-sitter]: https://tree-sitter.github.io/
21
22use tree_sitter_language::LanguageFn;
23
24extern "C" {
25 fn tree_sitter_gitcommit() -> *const ();
26}
27
28/// The tree-sitter [`LanguageFn`][LanguageFn] for this grammar.
29///
30/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
31pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_gitcommit) };
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#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 HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
40
41/// The language injection query for this language.
42pub const INJECTIONS_QUERY: &str = include_str!("../../queries/injections.scm");
43
44#[cfg(test)]
45mod tests {
46 #[test]
47 fn test_can_load_grammar() {
48 let mut parser = tree_sitter::Parser::new();
49 parser
50 .set_language(&super::LANGUAGE.into())
51 .expect("Error loading gitcommit grammar");
52 }
53}