tfdoc 0.1.5

Generate Terraform module documentation
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

use crate::types::{BlockType, DocItem};

pub fn render(result: &[DocItem]) {
    for item in result.iter().filter(|i| i.category == BlockType::Comment) {
        print_title_block(&item.description);
    }
    print_resources(result, "Resources", BlockType::Resource);
    print_interface(result, "Inputs", BlockType::Variable);
    print_interface(result, "Outputs", BlockType::Output);
}

fn print_title_block(description: &[String]) {
    let title = &description.first().unwrap()["Title: ".len()..];
    println!("# {}\n", title);
    for line in description.iter().skip(1) {
        println!("{}", line);
    }
}

fn print_resources(result: &[DocItem], name: &str, variant: BlockType) {
    for (index, item) in result
        .iter()
        .filter(|i| i.category == variant && i.description.len() > 0)
        .enumerate()
    {
        if index == 0 {
            println!("\n## {}\n", name);
        }
        if item.description.len() > 0 || variant != BlockType::Resource {
            println!("* `{}`: {}", item.name, item.description.join(" "));
        }
    }
}

fn print_interface(result: &[DocItem], name: &str, variant: BlockType) {
    for (index, item) in result.iter().filter(|i| i.category == variant).enumerate() {
        if index == 0 {
            println!("\n## {}\n", name);
        }
        if item.description.len() > 0 {
            println!("* `{}`: {}", item.name, item.description.join(" "));
        } else {
            println!("* `{}`", item.name);
        }
    }
}