farve 0.1.3

Tiny macros for owo-color'ful logging and printing
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
153
154
155
156
157
158
159

extern crate owo_colors;

/// Wraps a string on either side with square brackets.
/// The brightness of the brackets can be set with the second argument (0-2).
///
/// `( "s" , 0 | 1 | 2 | _ ) -> "[s]"`
///
/// # Examples
/// ```
/// use owo_colors::OwoColorize;
/// use farve::brackets;
///
/// let i0 = brackets!("INFO");
/// ```
#[macro_export]
macro_rules! brackets {
    ($msg:expr) => {
        format!("{}{}{}", '[', $msg, ']')
    };

    ($level:expr, $bracket_brightness:expr) => {
        match $bracket_brightness {
            0 => format!(
                "{}{}{}",
                '['.black().dimmed().bold(),
                $level,
                ']'.black().dimmed().bold()
            ),
            1 => format!(
                "{}{}{}",
                '['.bright_black().bold(),
                $level,
                ']'.bright_black().bold()
            ),
            2 => format!("{}{}{}", '['.white().bold(), $level, ']'.white().bold()),
            _ => format!("{}{}{}", '[', $level, ']'),
        }
    };
}

/// Create a new println function with a prefix and brackets (0-2 brightness).
///
/// `level` - any prefix.
/// `msg` - it should not be wrapped in quotes.
/// `bracket_brightness` - the brightness of the brackets (default: 0).
/// # Examples
/// ```
/// use owo_colors::OwoColorize;
/// use farve::prettyln;
///
/// prettyln!("info", "The weather is nice today.");
/// prettyln!("warn".yellow(), "I almost couldn't, but I did it!");
/// ```
#[macro_export]
macro_rules! prettyln {
    ($level:expr, $msg:expr, $bracket_brightness:expr) => {
        println!("{} {}", farve::brackets!($level, $bracket_brightness), $msg)
    };
    ($level:expr, $msg:expr) => {
        println!("{} {}", farve::brackets!($level), $msg)
    };
    ($level:expr) => {
        println!("{} {}", farve::brackets!($level))
    };
}

/// Create a new eprintln function with a prefix and brackets (0-2 brightness).
///
/// The first argument is the name of the function, it should not be wrapped in quotes.
/// The second argument is the prefix, it should be wrapped in quotes (default: function name).
/// The third argument is the brightness of the brackets (default: 0).
#[macro_export]
macro_rules! eprettyln {
    ($level:expr, $msg:expr, $bracket_brightness:expr) => {
        eprintln!("{} {}", farve::brackets!($level, $bracket_brightness), $msg)
    };
    ($level:expr, $msg:expr) => {
        eprintln!("{} {}", farve::brackets!($level), $msg)
    };
    ($level:expr) => {
        eprintln!("{} {}", farve::brackets!($level))
    };
}

/// Create a new println function with a prefix and brackets (0-2 brightness).
///
/// `$func` - the name of the function, it should not be wrapped in quotes.
/// `$prefix` - the prefix, it should be wrapped in quotes (default: function name).
/// `$bracket_brightness` - `0 | 1 | 2`; brightness of the brackets (default: 0).
///
/// # Examples
/// ```
/// use owo_colors::OwoColorize;
/// use farve::farve;
///
/// farve!(silly, "silly 😋".white().bold(), 2);
/// farve!(info);
/// farve!(warn, "warn".yellow().underline());
///
///
/// silly("Hello, world!");
/// info("The weather is nice today.");
/// warn("I almost couldn't, but I did it!");
/// ```
/// # Output (imagine color)
/// ```log
/// [silly 😋] Hello, world!
/// [info] The weather is nice today.
/// [warn] I almost couldn't, but I did it!
/// ```
#[macro_export]
macro_rules! farve {
    ($func:ident, $prefix:expr, $bracket_brightness:expr) => {
        pub fn $func<S: std::fmt::Display>(msg: S) {
            farve::prettyln!($prefix, msg, $bracket_brightness)
        }
    };
    ($func:ident, $prefix:expr) => {
        pub fn $func<S: std::fmt::Display>(msg: S) {
            farve::prettyln!($prefix, msg)
        }
    };
    ($func:ident) => {
        pub fn $func<S: std::fmt::Display>(msg: S) {
            farve::prettyln!(stringify!($func), msg)
        }
    };
}
/// Just like `farve!`, but prints to stderr instead of stdout. Creates an eprintln with a prefix and brackets (0-2 brightness).
///
/// `$func` - the name of the function, it should not be wrapped in quotes.
/// `$prefix` - the prefix, it should be wrapped in quotes (default: function name).
/// `$bracket_brightness` - `0 | 1 | 2`; brightness of the brackets (default: 0).
///
/// # Examples
/// ```
/// use owo_colors::OwoColorize;
/// use farve::efarve;
///
/// efarve!(warn, "WARN".yellow().underline(), 1);
/// efarve!(skip, "skip".bright_black().italic());
#[macro_export]
macro_rules! efarve {
    ($func:ident, $prefix:expr, $bracket_brightness:expr) => {
        pub fn $func<S: std::fmt::Display>(msg: S) {
            farve::eprettyln!($prefix, msg, $bracket_brightness)
        }
    };
    ($func:ident, $prefix:expr) => {
        pub fn $func<S: std::fmt::Display>(msg: S) {
            farve::eprettyln!($prefix, msg)
        }
    };
    ($func:ident) => {
        pub fn $func<S: std::fmt::Display>(msg: S) {
            farve::eprettyln!(stringify!($func), msg)
        }
    };
}