normalize_languages/
vim.rs

1//! Vim script language support.
2
3use crate::{Import, Language, LanguageSymbols, Visibility};
4use tree_sitter::Node;
5
6/// Vim script language support.
7pub struct Vim;
8
9impl Language for Vim {
10    fn name(&self) -> &'static str {
11        "Vim"
12    }
13    fn extensions(&self) -> &'static [&'static str] {
14        &["vim", "vimrc"]
15    }
16    fn grammar_name(&self) -> &'static str {
17        "vim"
18    }
19
20    fn as_symbols(&self) -> Option<&dyn LanguageSymbols> {
21        Some(self)
22    }
23
24    fn extract_imports(&self, node: &Node, content: &str) -> Vec<Import> {
25        let text = &content[node.byte_range()];
26        let line = node.start_position().row + 1;
27
28        // source file.vim, runtime path/to/file.vim
29        let module = text
30            .strip_prefix("source ")
31            .or_else(|| text.strip_prefix("runtime "))
32            .map(|rest| rest.trim().to_string());
33
34        if let Some(module) = module {
35            return vec![Import {
36                module,
37                names: Vec::new(),
38                alias: None,
39                is_wildcard: false,
40                is_relative: true,
41                line,
42            }];
43        }
44
45        Vec::new()
46    }
47
48    fn format_import(&self, import: &Import, _names: Option<&[&str]>) -> String {
49        // Vim: source file.vim or runtime path/file.vim
50        if import.is_relative {
51            format!("source {}", import.module)
52        } else {
53            format!("runtime {}", import.module)
54        }
55    }
56
57    fn get_visibility(&self, node: &Node, content: &str) -> Visibility {
58        if self
59            .node_name(node, content)
60            .is_none_or(|n| !n.starts_with("s:"))
61        {
62            Visibility::Public
63        } else {
64            Visibility::Private
65        }
66    }
67
68    fn is_test_symbol(&self, symbol: &crate::Symbol) -> bool {
69        let name = symbol.name.as_str();
70        match symbol.kind {
71            crate::SymbolKind::Function | crate::SymbolKind::Method => name.starts_with("test_"),
72            crate::SymbolKind::Module => name == "tests" || name == "test",
73            _ => false,
74        }
75    }
76}
77
78impl LanguageSymbols for Vim {}
79
80#[cfg(test)]
81mod tests {
82    use super::*;
83    use crate::validate_unused_kinds_audit;
84
85    #[test]
86    fn unused_node_kinds_audit() {
87        #[rustfmt::skip]
88        let documented_unused: &[&str] = &[
89            "aboveleft_statement", "autocmd_statement",
90            "bang_filter_statement", "belowright_statement", "body", "botright_statement",
91            "break_statement", "call_expression", "call_statement", "catch_statement",
92            "cnext_statement", "colorscheme_statement", "comclear_statement",
93            "command_statement", "const_statement", "continue_statement", "cprevious_statement",
94            "delcommand_statement", "dictionnary_entry", "echo_statement", "echoerr_statement",
95            "echohl_statement", "echomsg_statement", "echon_statement", "edit_statement",
96            "else_statement", "enew_statement", "eval_statement", "ex_statement",
97            "execute_statement", "field_expression", "file_format", "filetype",
98            "filetype_statement", "filetypes", "finally_statement", "find_statement",
99            "global_statement", "highlight_statement", "identifier",
100            "index_expression", "lambda_expression", "let_statement", "lua_statement",
101            "map_statement", "marker_definition", "match_case", "method_expression",
102            "normal_statement", "options_statement", "perl_statement", "python_statement",
103            "range_statement", "register_statement", "return_statement", "ruby_statement",
104            "scoped_identifier", "scriptencoding_statement", "set_statement",
105            "setfiletype_statement", "setlocal_statement", "sign_statement", "silent_statement",
106            "slice_expression", "startinsert_statement", "stopinsert_statement",
107            "substitute_statement", "syntax_statement", "ternary_expression",
108            "throw_statement", "topleft_statement", "unknown_builtin_statement",
109            "unlet_statement", "vertical_statement", "view_statement", "visual_statement",
110            "wincmd_statement",
111            // Control flow — not definition constructs
112            "elseif_statement", "for_loop", "if_statement", "source_statement",
113            "try_statement", "runtime_statement", "while_loop",
114            // control flow — not extracted as symbols
115
116        ];
117        validate_unused_kinds_audit(&Vim, documented_unused)
118            .expect("Vim unused node kinds audit failed");
119    }
120}
normalize_languages/vim.rs

normalize_languages/
vim.rs
