tree_sitter_vim/
lib.rs

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

tree_sitter_vim/
lib.rs
