tokmd-analysis 1.13.1

Analysis logic and enrichers for tokmd receipts.
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
87
88
89
90
91

use super::rust;

pub const AST_SHADOW_SCHEMA_VERSION: &str = "tokmd.ast_shadow.v1";
pub const SYNTAX_RECEIPT_SCHEMA_VERSION: &str = "tokmd.syntax_receipt.v1";

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum AstLanguage {
    Python,
    Rust,
    TypeScript,
    Tsx,
}

impl AstLanguage {
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Python => "python",
            Self::Rust => "rust",
            Self::TypeScript => "typescript",
            Self::Tsx => "tsx",
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum AstParserStatus {
    ParserBackedShadow,
    Unsupported,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct AstCapability {
    pub language: AstLanguage,
    pub parser_crate: &'static str,
    pub parser_status: AstParserStatus,
    pub shadow_only: bool,
    pub changes_default_receipts: bool,
}

impl AstCapability {
    pub const fn parser_backed_shadow(language: AstLanguage, parser_crate: &'static str) -> Self {
        Self {
            language,
            parser_crate,
            parser_status: AstParserStatus::ParserBackedShadow,
            shadow_only: true,
            changes_default_receipts: false,
        }
    }
}

#[must_use]
pub fn capabilities() -> &'static [AstCapability] {
    rust::CAPABILITIES
}

#[cfg(test)]
mod tests {
    use super::{
        AST_SHADOW_SCHEMA_VERSION, AstCapability, AstLanguage, AstParserStatus,
        SYNTAX_RECEIPT_SCHEMA_VERSION,
    };

    #[test]
    fn parser_backed_shadow_constructor_never_changes_default_receipts() {
        let capability = AstCapability::parser_backed_shadow(AstLanguage::Rust, "tree-sitter-rust");

        assert_eq!(capability.language.as_str(), "rust");
        assert_eq!(
            capability.parser_status,
            AstParserStatus::ParserBackedShadow
        );
        assert!(capability.shadow_only);
        assert!(!capability.changes_default_receipts);
    }

    #[test]
    fn syntax_languages_have_stable_wire_values() {
        assert_eq!(AstLanguage::Python.as_str(), "python");
        assert_eq!(AstLanguage::Rust.as_str(), "rust");
        assert_eq!(AstLanguage::TypeScript.as_str(), "typescript");
        assert_eq!(AstLanguage::Tsx.as_str(), "tsx");
    }

    #[test]
    fn schema_names_are_stable() {
        assert_eq!(AST_SHADOW_SCHEMA_VERSION, "tokmd.ast_shadow.v1");
        assert_eq!(SYNTAX_RECEIPT_SCHEMA_VERSION, "tokmd.syntax_receipt.v1");
    }
}