tokmd-analysis 1.14.0

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

//! Lightweight multi-language symbol scanning for API surface reports.
//!
//! This module owns heuristic source scanning only. The parent module owns
//! receipt aggregation and stable report construction.

#[cfg(test)]
mod tests;

mod go;
mod java;
mod js_ts;
mod python;
mod rust;

/// Languages supported for API surface analysis.
pub(super) fn is_api_surface_lang(lang: &str) -> bool {
    matches!(
        lang.to_lowercase().as_str(),
        "rust" | "javascript" | "typescript" | "python" | "go" | "java"
    )
}

/// Represents a single discovered symbol.
#[derive(Debug)]
pub(super) struct Symbol {
    pub(super) is_public: bool,
    pub(super) is_documented: bool,
}

/// Scan a file for public/internal symbols and documentation.
pub(super) fn extract_symbols(lang: &str, text: &str) -> Vec<Symbol> {
    let lines: Vec<&str> = text.lines().collect();
    match lang.to_lowercase().as_str() {
        "rust" => rust::extract_symbols(&lines),
        "javascript" | "typescript" => js_ts::extract_symbols(&lines),
        "python" => python::extract_symbols(&lines),
        "go" => go::extract_symbols(&lines),
        "java" => java::extract_symbols(&lines),
        _ => Vec::new(),
    }
}

/// Check whether the line preceding a symbol looks like a doc comment.
pub(super) fn has_doc_comment(lines: &[&str], idx: usize) -> bool {
    if idx == 0 {
        return false;
    }
    let prev = lines[idx - 1].trim();
    // Rust: /// or //! or #[doc
    // JS/TS/Java: /** or //
    // Python: """ or ''' (handled separately)
    // Go: // directly before declaration
    prev.starts_with("///")
        || prev.starts_with("//!")
        || prev.starts_with("/**")
        || prev.starts_with("#[doc")
        || prev.starts_with("/// ")
        || prev.starts_with("// ")
        || prev.starts_with("\"\"\"")
        || prev.starts_with("'''")
}