typegen 0.1.1-alpha.0

Generate TypeScript, Flow, and Hack types from Rust struct definitions
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

// Copyright (c) Meta Platforms, Inc. and affiliates.

pub enum DocFormat {
    /// /* docs */
    Block,
    /// // docs
    TwoSlash,
}

pub fn render_docs(docs: &Option<String>, format: DocFormat, indent: usize) -> String {
    if let Some(docs) = docs {
        let indent_str = " ".repeat(indent);

        match format {
            DocFormat::Block => {
                let is_multiline = docs.contains('\n');
                if !is_multiline {
                    format!("{indent_str}/** {} */\n", docs.trim())
                } else {
                    let result: String = docs
                        .lines()
                        .map(|line| format!("{} * {}\n", indent_str, line))
                        .collect();
                    format!("{indent_str}/**\n{}\n{indent_str} */\n", result.trim_end())
                }
            }
            DocFormat::TwoSlash => docs
                .lines()
                .map(|line| format!("{}// {}\n", indent_str, line))
                .collect::<String>(),
        }
    } else {
        String::new()
    }
}

#[cfg(test)]
mod tests {
    use k9::snapshot;

    use super::*;
    #[test]
    fn test_render_docs() {
        let missing = render_docs(&None, DocFormat::Block, 2);
        snapshot!(missing, "");

        let single_line_ss = render_docs(&Some("meow".to_string()), DocFormat::TwoSlash, 2);
        snapshot!(
            single_line_ss,
            "
  // meow

"
        );
        let multiline_line_ss = render_docs(
            &Some("meow\nwoof\n\napple".to_string()),
            DocFormat::TwoSlash,
            4,
        );
        snapshot!(
            multiline_line_ss,
            "
    // meow
    // woof
    // 
    // apple

"
        );

        let single_line_block = render_docs(&Some("meow".to_string()), DocFormat::Block, 2);
        snapshot!(
            single_line_block,
            "
  /** meow */

"
        );
        let multiline_line_block = render_docs(
            &Some("meow\nwoof\n\napple".to_string()),
            DocFormat::Block,
            4,
        );
        snapshot!(
            multiline_line_block,
            "
    /**
     * meow
     * woof
     * 
     * apple
     */

"
        );
    }
}