sqry-nl 4.8.16

Natural language to sqry query translation layer
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

//! Template definitions for command assembly.
//!
//! This module contains the template patterns used for validation
//! and documentation purposes.

/// Template pattern documentation.
///
/// Each template shows the expected format of assembled commands.
pub const TEMPLATES: &[(&str, &str)] = &[
    (
        "query",
        r#"sqry query "<expr> [kind:<kind>] [predicate:value]..." [--language <lang>]* [--path "<glob>"] [--limit N]"#,
    ),
    (
        "search",
        r#"sqry search "<pattern>" [--language <lang>]* [--path "<glob>"]"#,
    ),
    (
        "trace-path",
        r#"sqry graph trace-path "<from>" "<to>" [--max-depth N]"#,
    ),
    (
        "direct-callers",
        r#"sqry graph direct-callers "<symbol>" [--language <lang>]"#,
    ),
    (
        "direct-callees",
        r#"sqry graph direct-callees "<symbol>" [--language <lang>]"#,
    ),
    (
        "visualize",
        r#"sqry visualize --relation <kind> --symbol "<name>" [--format mermaid|dot|json]"#,
    ),
    (
        "index-status",
        r#"sqry index --status [--path "<path>"] [--json]"#,
    ),
];

/// Get template documentation by name.
#[must_use]
pub fn get_template(name: &str) -> Option<&'static str> {
    TEMPLATES
        .iter()
        .find(|(n, _)| *n == name)
        .map(|(_, template)| *template)
}

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

    #[test]
    fn test_get_template() {
        assert!(get_template("query").is_some());
        assert!(get_template("unknown").is_none());
    }

    #[test]
    fn test_all_templates_exist() {
        assert_eq!(TEMPLATES.len(), 7);
    }
}