supplement 0.2.3

The awesome supplement for your awesome CLI app
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

//! Qucikstart: Check the example of [`Supplement`].
//! Derive it and call [`Supplement::supplement`] to start the CLI compleiton.

pub mod completion;
pub mod core;
pub mod error;
pub mod gen_prelude;
pub mod id;
pub mod seen;
mod supplement;

pub(crate) mod abstraction;
pub(crate) mod arg_context;
pub(crate) mod parsed_flag;

pub use completion::{Completion, CompletionGroup};
pub use seen::Seen;
pub use supplement::Supplement;
pub use supplement_proc_macro::Supplement;

pub type Result<T = ()> = std::result::Result<T, error::Error>;

pub mod helper {
    //! Helper functions/macros to make your life easier.
    pub use supplement_proc_macro::{id, id_codegen, id_no_assoc};
}

#[cfg(all(feature = "clap-3", feature = "clap-4"))]
compile_error!("Only one of the clap features can be enabled");

#[cfg(feature = "clap-3")]
pub(crate) use clap3 as clap;
#[cfg(feature = "clap-4")]
pub(crate) use clap4 as clap;

#[cfg(any(feature = "clap-3", feature = "clap-4"))]
pub mod generate;

/// Enum to represent different shell. Use [`str::parse`] to create it.
///
/// ```rust
/// use supplement::Shell;
/// let shell: Shell = "fish".parse().unwrap();
/// assert_eq!(shell, Shell::Fish);
/// ```
#[derive(Clone, Copy, Eq, PartialEq, Debug)]
#[non_exhaustive]
pub enum Shell {
    Zsh,
    Fish,
    Bash,
}
impl std::str::FromStr for Shell {
    type Err = String;
    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        let ret = match s {
            "zsh" => Shell::Zsh,
            "fish" => Shell::Fish,
            "bash" => Shell::Bash,
            _ => return Err(format!("Unknown shell {}", s)),
        };

        Ok(ret)
    }
}