normalize-languages 0.3.1

Tree-sitter language support and dynamic grammar loading
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! Cap'n Proto schema support.

use crate::{Import, Language, LanguageSymbols};
use tree_sitter::Node;

/// Cap'n Proto language support.
pub struct Capnp;

impl Language for Capnp {
    fn name(&self) -> &'static str {
        "Cap'n Proto"
    }
    fn extensions(&self) -> &'static [&'static str] {
        &["capnp"]
    }
    fn grammar_name(&self) -> &'static str {
        "capnp"
    }

    fn as_symbols(&self) -> Option<&dyn LanguageSymbols> {
        Some(self)
    }

    fn extract_imports(&self, node: &Node, content: &str) -> Vec<Import> {
        if node.kind() != "import" {
            return Vec::new();
        }

        let text = &content[node.byte_range()];
        vec![Import {
            module: text.trim().to_string(),
            names: Vec::new(),
            alias: None,
            is_wildcard: false,
            is_relative: false,
            line: node.start_position().row + 1,
        }]
    }

    fn format_import(&self, import: &Import, _names: Option<&[&str]>) -> String {
        // Cap'n Proto: using import "file.capnp"
        format!("using import \"{}\"", import.module)
    }

    fn container_body<'a>(&self, node: &'a Node<'a>) -> Option<Node<'a>> {
        node.child_by_field_name("body")
    }
}

impl LanguageSymbols for Capnp {}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::validate_unused_kinds_audit;

    #[test]
    fn unused_node_kinds_audit() {
        #[rustfmt::skip]
        let documented_unused: &[&str] = &[
            // Type-related
            "type_identifier", "type_definition", "primitive_type", "list_type",
            "custom_type", "field_type", "extend_type",
            // Method-related
            "method_identifier", "method_parameters", "return_type", "return_identifier",
            "named_return_type", "named_return_types", "unnamed_return_type", "param_identifier",
            // Struct/enum-related
            "nested_struct", "nested_enum", "enum_field", "enum_member", "enum_identifier",
            "field_identifier", "struct_shorthand",
            // Import-related
            "import_path", "import_using",
            // Other
            "const_identifier", "generic_identifier", "annotation_identifier",
            "annotation_definition_identifier", "unique_id_statement",
            "top_level_annotation_body", "block_text",
            // covered by tags.scm
            "enum",
            "interface",
            "method",
            "struct",
            "import",
        ];
        validate_unused_kinds_audit(&Capnp, documented_unused)
            .expect("Cap'n Proto unused node kinds audit failed");
    }
}