mant-core 0.6.0

Structured manual and Markdown document engine used by ManT
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Serializes stable native contracts directly from their Rust source types.

use mant_ast::{QueryBundle, QueryExcerpt, QueryOutline, QuerySearch, TldrCacheUpdate};

/// Serialize a query contract in compact or human-readable form.
///
/// # Errors
///
/// Propagates the unlikely JSON writer failure from [`serde_json`].
pub fn render_query_json(query: &QueryBundle, pretty: bool) -> Result<String, serde_json::Error> {
    render_json(query, pretty)
}

/// Serialize a complete query outline in compact or human-readable form.
///
/// # Errors
///
/// Propagates the unlikely JSON writer failure from [`serde_json`].
pub fn render_outline_json(
    outline: &QueryOutline,
    pretty: bool,
) -> Result<String, serde_json::Error> {
    render_json(outline, pretty)
}

/// Serialize selected query nodes in compact or human-readable form.
///
/// # Errors
///
/// Propagates the unlikely JSON writer failure from [`serde_json`].
pub fn render_excerpt_json(
    excerpt: &QueryExcerpt,
    pretty: bool,
) -> Result<String, serde_json::Error> {
    render_json(excerpt, pretty)
}

/// Serialize structure-aware search results in compact or human-readable form.
///
/// # Errors
///
/// Propagates the unlikely JSON writer failure from [`serde_json`].
pub fn render_search_json(search: &QuerySearch, pretty: bool) -> Result<String, serde_json::Error> {
    render_json(search, pretty)
}

/// Serialize the explicit tldr update result for a process boundary.
///
/// # Errors
///
/// Propagates the unlikely JSON writer failure from [`serde_json`].
pub fn render_update_json(
    update: &TldrCacheUpdate,
    pretty: bool,
) -> Result<String, serde_json::Error> {
    render_json(update, pretty)
}

fn render_json(value: &impl serde::Serialize, pretty: bool) -> Result<String, serde_json::Error> {
    if pretty {
        serde_json::to_string_pretty(value)
    } else {
        serde_json::to_string(value)
    }
}

#[cfg(test)]
mod tests {
    use mant_ast::{QueryBundle, QuerySchema, TldrCacheAction, TldrCacheUpdate};

    use super::{render_query_json, render_update_json};

    #[test]
    fn compact_and_pretty_query_output_share_the_same_contract() {
        let query = QueryBundle {
            schema: QuerySchema::V6,
            label: "ls".to_owned(),
            document: None,
            tldr: None,
        };
        let compact = render_query_json(&query, false).expect("compact JSON");
        let pretty = render_query_json(&query, true).expect("pretty JSON");

        assert_eq!(compact, r#"{"schema":"mant.query/v6","label":"ls"}"#);
        assert!(pretty.contains("\n  \"label\": \"ls\""));
        assert_eq!(
            serde_json::from_str::<serde_json::Value>(&compact).expect("compact value"),
            serde_json::from_str::<serde_json::Value>(&pretty).expect("pretty value")
        );
    }

    #[test]
    fn update_json_omits_absent_provider_fields() {
        let update = TldrCacheUpdate {
            action: TldrCacheAction::Cloned,
            cache_dir: Some("/cache/tldr".to_owned()),
            client: None,
            output: None,
            revision: Some("abc123".to_owned()),
        };

        assert_eq!(
            render_update_json(&update, false).expect("update JSON"),
            r#"{"action":"cloned","cacheDir":"/cache/tldr","revision":"abc123"}"#
        );
        assert!(
            render_update_json(&update, true)
                .expect("pretty update JSON")
                .contains("\n  \"cacheDir\": \"/cache/tldr\",")
        );
    }
}