immargs 0.1.4

No-hassle, on-the-spot, command line argument parser
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
148
149
150
151
152

use immargs::Error;
use immargs::args;
use indoc::indoc;

macro_rules! assert_help {
    ($result:expr, $help:expr) => {{
        let Err(Error::Help { message }) = $result else {
            panic!("should be a help error");
        };
        println!("[\n{message}]");
        assert!(message == $help);
    }};
}

#[test]
fn help_empty() {
    args! {
        -h --help   "Print help message",
    }

    let help = indoc! {"
        usage: test [options]

        options:
           -h, --help     Print help message
    "};

    let args = Args::try_from_raw(["test", "-h"]);
    assert_help!(&args, help);
}

#[test]
fn help_option() {
    args! {
        --aaa                   "Help aaa",
        -b --bbb                "Help bbb",
        -x -y -z --ccc          "Help ccc",
        --ddd <value> String    "Help ddd",
        -e --eee <value> String "Help eee",
        -h --help               "Print help message",
    }

    let help = indoc! {"
        usage: test [options]

        options:
           --aaa                 Help aaa
           -b, --bbb             Help bbb
           -x, -y, -z, --ccc     Help ccc
           --ddd <value>         Help ddd
           -e, --eee <value>     Help eee
           -h, --help            Print help message
    "};

    let args = Args::try_from_raw(["test", "-h"]);
    assert_help!(&args, help);
}

#[test]
fn help_non_option_required() {
    args! {
        -h --help        "Print help message",
        <aaa> String     "Help aaa",
        <bbb>... String  "Help bbb",
    }

    let help = indoc! {"
        usage: test [options] <aaa> <bbb>...

        options:
           -h, --help     Print help message

        arguments:
           <aaa>          Help aaa
           <bbb>...       Help bbb
    "};

    let args = Args::try_from_raw(["test", "-h"]);
    assert_help!(&args, help);
}

#[test]
fn help_non_option_optional() {
    args! {
        -h --help          "Print help message",
        [<aaa>] String     "Help aaa",
        [<bbb>...] String  "Help bbb",
    }

    let help = indoc! {"
        usage: test [options] [<aaa>] [<bbb>...]

        options:
           -h, --help     Print help message

        arguments:
           [<aaa>]        Help aaa
           [<bbb>...]     Help bbb
    "};

    let args = Args::try_from_raw(["test", "-h"]);
    assert_help!(&args, help);
}

#[test]
fn help_non_option_no_help() {
    args! {
        -h --help        "Print help message",
        <aaa> String,
        [<bbb>...] String,
    }

    let help = indoc! {"
        usage: test [options] <aaa> [<bbb>...]

        options:
           -h, --help     Print help message
    "};

    let args = Args::try_from_raw(["test", "-h"]);
    assert_help!(&args, help);
}

#[test]
fn help_non_option_command() {
    args! {
        -h --help           "Print help message",
        <command> Command   "This is a command" {
            add             "Add file(s)",
            remove rm       "Remove file(s)",
            list ls l       "List file(s)",
        },
    }

    let help = indoc! {"
        usage: test [options] <command> [...]

        options:
           -h, --help      Print help message

        arguments:
           <command>       This is a command

        commands:
           add             Add file(s)
           remove, rm      Remove file(s)
           list, ls, l     List file(s)
    "};

    let args = Args::try_from_raw(["test", "-h"]);
    assert_help!(&args, help);
}