halp 0.2.0

A CLI tool to get help with CLI tools 🐙
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

/// Display trait for an argument.
pub trait ArgDisplay {
    /// Returns the string representation.
    fn as_str(&self) -> &'static str;
}

macro_rules! generate_argument {
    ($name: ident,
     $($variant: ident => $str_repr: expr,)+
    ) => {
        /// Argument.
        #[derive(Clone, Copy, Debug, PartialEq, Eq)]
        pub enum $name {
            $(
                /// Variant of the argument.
                $variant
            ),+
        }

        impl $name {
            /// Returns the variants.
            pub fn variants() -> Vec<Box<dyn ArgDisplay>> {
                vec![$(Box::new(Self::$variant),)+]
            }

        }

        impl ArgDisplay for $name {
            fn as_str(&self) -> &'static str {
                match self {
                    $(Self::$variant => $str_repr,)+
                }
            }
        }
    };
}

generate_argument!(
    VersionArg,
    Version => "-v",
    CapitalVersion => "-V",
    LongVersion => "--version",
    SubcommandVersion => "version",
);

generate_argument!(
    HelpArg,
    Help => "-h",
    LongHelp => "--help",
    SubcommandHelp => "help",
    CapitalHelp => "-H",
);

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;

    generate_argument!(
        Test,
        One => "one",
        Two => "two",
        Three => "three",
    );

    #[test]
    fn test_enum_generation() {
        assert_eq!(
            vec!["one", "two", "three"],
            Test::variants()
                .iter()
                .map(|v| v.as_str())
                .collect::<Vec<_>>()
        );
    }
}