clap_autodoc 0.2.1

Auto-generate markdown documentation tables from clap configuration structs
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use clap::Parser;
use clap_autodoc::generate;

#[derive(Clone, Debug, Parser)]
#[clap(rename_all = "kebab-case")]
#[clap_autodoc::register]
pub struct DatabaseConfig {
    /// Database host
    #[clap(env = "POSTGRES_HOST", long)]
    pub postgres_host: String,

    /// Database port
    #[clap(env = "POSTGRES_PORT", long, default_value_t = 5432)]
    pub postgres_port: u16,

    #[clap(env = "POSTGRES_USER", long)]
    pub postgres_user: String,

    #[clap(env = "POSTGRES_PASSWORD", long)]
    pub postgres_password: String,

    #[clap(env = "POSTGRES_DATABASE", long, default_value = "data-ingestion")]
    pub postgres_database: String,
}

#[derive(Clone, Debug, Parser)]
#[clap(rename_all = "kebab-case")]
#[clap_autodoc::register]
pub struct RedisConfig {
    /// Redis host
    #[clap(env = "REDIS_HOST", long)]
    pub redis_host: String,

    /// Redis port
    #[clap(env = "REDIS_PORT", long, default_value_t = 6379)]
    pub redis_port: u16,
}

#[derive(Clone, Debug, Parser)]
#[clap(rename_all = "kebab-case")]
#[generate(target = "tests/output/nested_flat_output.md", format = "flat")]
pub struct NestedConfigFlat {
    /// Database configuration
    #[clap(flatten)]
    pub database: DatabaseConfig,

    /// Redis configuration  
    #[clap(flatten)]
    pub redis: RedisConfig,

    /// Server port
    #[clap(env = "SERVER_PORT", long, default_value_t = 8080)]
    pub port: u16,
}

#[derive(Clone, Debug, Parser)]
#[clap(rename_all = "kebab-case")]
#[generate(target = "tests/output/nested_grouped_output.md", format = "grouped")]
pub struct NestedConfigGrouped {
    /// Database configuration
    #[clap(flatten)]
    pub database: DatabaseConfig,

    /// Redis configuration  
    #[clap(flatten)]
    pub redis: RedisConfig,

    /// Server port
    #[clap(env = "SERVER_PORT", long, default_value_t = 8080)]
    pub port: u16,
}

#[test]
fn test_nested_flat_format() {
    // Check if the flat format file was created
    assert!(std::path::Path::new("tests/output/nested_flat_output.md").exists());

    // Read the generated content
    let content = std::fs::read_to_string("tests/output/nested_flat_output.md").unwrap();

    // Expected output for flat format with expanded flattened fields
    let expected = vec![
        "[//]: # (CONFIG_DOCS_START)",
        "",
        "| Field Name        | Type   | Required | Default        | Details       | Group            |",
        "|-------------------|--------|----------|----------------|---------------|------------------|",
        "| postgres-host     | String | Yes      | -              | Database host | DatabaseConfig   |",
        "| postgres-port     | u16    | No       | 5432           | Database port | DatabaseConfig   |",
        "| postgres-user     | String | Yes      | -              |               | DatabaseConfig   |",
        "| postgres-password | String | Yes      | -              |               | DatabaseConfig   |",
        "| postgres-database | String | No       | data-ingestion |               | DatabaseConfig   |",
        "| redis-host        | String | Yes      | -              | Redis host    | RedisConfig      |",
        "| redis-port        | u16    | No       | 6379           | Redis port    | RedisConfig      |",
        "| port              | u16    | No       | 8080           | Server port   | NestedConfigFlat |",
        "",
        "[//]: # (CONFIG_DOCS_END)"
    ].join("\n");

    // Compare the generated content with expected output
    assert_eq!(content.trim(), expected.trim());
}

#[test]
fn test_nested_grouped_format() {
    assert!(std::path::Path::new("tests/output/nested_grouped_output.md").exists());

    let content = std::fs::read_to_string("tests/output/nested_grouped_output.md").unwrap();

    let expected = vec![
        "[//]: # (CONFIG_DOCS_START)",
        "",
        "## DatabaseConfig Configuration",
        "",
        "| Field Name        | Type   | Required | Default        | Details       |",
        "|-------------------|--------|----------|----------------|---------------|",
        "| postgres-host     | String | Yes      | -              | Database host |",
        "| postgres-port     | u16    | No       | 5432           | Database port |",
        "| postgres-user     | String | Yes      | -              |               |",
        "| postgres-password | String | Yes      | -              |               |",
        "| postgres-database | String | No       | data-ingestion |               |",
        "",
        "## RedisConfig Configuration",
        "",
        "| Field Name | Type   | Required | Default | Details    |",
        "|------------|--------|----------|---------|------------|",
        "| redis-host | String | Yes      | -       | Redis host |",
        "| redis-port | u16    | No       | 6379    | Redis port |",
        "",
        "## NestedConfigGrouped Configuration",
        "",
        "| Field Name | Type | Required | Default | Details     |",
        "|------------|------|----------|---------|-------------|",
        "| port       | u16  | No       | 8080    | Server port |",
        "",
        "",
        "",
        "[//]: # (CONFIG_DOCS_END)",
    ]
    .join("\n");

    assert_eq!(content.trim(), expected.trim());
}