clap_fmt 0.1.1

Serialize a clap arg parser into the command-line arguments.
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
143
144
145
146
147

use clap::Parser;
use clap_fmt::FmtArgs;
use serde::Serialize;

// Test different argument positions
#[derive(Parser, Debug, Serialize)]
struct CliWithPositions {
    #[arg(index = 1)]
    first: String,

    #[arg(index = 2)]
    second: String,

    #[arg(long)]
    flag: bool,

    #[arg(index = 3, num_args = 1..)]
    rest: Vec<String>,
}

#[test]
fn test_positional_ordering() {
    let cli = CliWithPositions {
        first: "one".to_string(),
        second: "two".to_string(),
        flag: true,
        rest: vec!["three".to_string(), "four".to_string()],
    };

    let result = cli.to_args();
    assert_eq!(result, vec!["one", "two", "--flag", "three", "four"]);
}

// Test short-only and long-only flags
#[derive(Parser, Debug, Serialize)]
struct CliWithShortLong {
    #[arg(short)]
    short_only: bool,

    #[arg(long)]
    long_only: bool,

    #[arg(short = 'x')]
    custom_short: bool,

    #[arg(long = "custom-long")]
    custom_long: bool,

    #[arg(short, long)]
    both: bool,
}

#[test]
fn test_short_long_flags() {
    let cli = CliWithShortLong {
        short_only: true,
        long_only: true,
        custom_short: true,
        custom_long: true,
        both: true,
    };

    let result = cli.to_args();
    assert_eq!(result, vec!["-s", "--long-only", "-x", "--custom-long", "--both"]);
}

// Test environment variables and other special cases
#[derive(Parser, Debug, Serialize)]
struct CliWithEnv {
    #[arg(long, env = "MY_CONFIG")]
    config: Option<String>,

    #[arg(long, hide = true)]
    hidden: bool,

    #[arg(long, alias = "colour")]
    color: bool,
}

#[test]
fn test_env_and_special() {
    let cli = CliWithEnv {
        config: Some("app.conf".to_string()),
        hidden: true,
        color: true,
    };

    let result = cli.to_args();
    assert_eq!(result, vec!["--config", "app.conf", "--hidden", "--color"]);
}

// Test exclusive and conflicting arguments
#[derive(Parser, Debug, Serialize)]
struct CliWithConflicts {
    #[arg(long, conflicts_with = "json")]
    xml: bool,

    #[arg(long, conflicts_with = "xml")]
    json: bool,

    #[arg(long, required_unless_present = "input")]
    output: Option<String>,

    #[arg(long, required_unless_present = "output")]
    input: Option<String>,
}

#[test]
fn test_conflicts() {
    let cli = CliWithConflicts {
        xml: true,
        json: false,
        output: Some("out.txt".to_string()),
        input: None,
    };

    let result = cli.to_args();
    assert_eq!(result, vec!["--xml", "--output", "out.txt"]);
}

// Test value names and help strings (they don't affect output but shouldn't break)
#[derive(Parser, Debug, Serialize)]
struct CliWithMetadata {
    /// This is a help string
    #[arg(short, long, value_name = "FILE", help = "Input file to process")]
    input: String,

    /// Another help string
    #[arg(
        short,
        long,
        value_name = "DIR",
        long_help = "Output directory for results"
    )]
    output: String,
}

#[test]
fn test_metadata_doesnt_break() {
    let cli = CliWithMetadata {
        input: "in.txt".to_string(),
        output: "out/".to_string(),
    };

    let result = cli.to_args();
    assert_eq!(result, vec!["--input", "in.txt", "--output", "out/"]);
}