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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
#![deny(warnings)]
#![deny(missing_docs)]

//! A logger configured via an environment variable which writes cancer to
//! standard error with colored output for log levels.
//!
//! ## Example
//!
//! ```
//! extern crate emoji_logger;
//! #[macro_use] extern crate log;
//!
//! fn main() {
//!     emoji_logger::init();
//!
//!     trace!("this is trace level");
//!     debug!("mom get the rubber duck");
//!     info!("heck, our disk is full of logs again...");
//!     warn!("should we worry");
//!     error!("pls help");
//! }
//! ```

extern crate ansi_term;
extern crate env_logger;
extern crate log;

use std::sync::atomic::{AtomicUsize, Ordering, ATOMIC_USIZE_INIT};
use std::time::Instant;

use ansi_term::{Color, Style};
use env_logger::Builder;
use log::Level;

static MAX_MODULE_WIDTH: AtomicUsize = ATOMIC_USIZE_INIT;
static SINCE_WIDTH_INCREASE: AtomicUsize = ATOMIC_USIZE_INIT;

/// Initializes the global logger with an emoji logger.
///
/// This should be called early in the execution of a Rust program, and the
/// global logger may only be initialized once. Future initialization attempts
/// will return an error.
///
/// # Panics
///
/// This function fails to set the global logger if one has already been set.
#[inline]
pub fn init() {
    try_init().unwrap();
}

/// Initializes the global logger with an emoji logger.
///
/// This should be called early in the execution of a Rust program, and the
/// global logger may only be initialized once. Future initialization attempts
/// will return an error.
///
/// # Errors
///
/// This function fails to set the global logger if one has already been set.
pub fn try_init() -> Result<(), log::SetLoggerError> {
    try_init_custom_env("RUST_LOG")
}

/// Initialized the global logger with an emoji logger, with a custom variable
/// name.
///
/// This should be called early in the execution of a Rust program, and the
/// global logger may only be initialized once. Future initialization attempts
/// will return an error.
///
/// # Panics
///
/// This function fails to set the global logger if one has already been set.
pub fn init_custom_env(environment_variable_name: &str) {
    try_init_custom_env(environment_variable_name).unwrap();
}

/// Initialized the global logger with an emoji logger, with a custom variable
/// name.
///
/// This should be called early in the execution of a Rust program, and the
/// global logger may only be initialized once. Future initialization attempts
/// will return an error.
///
/// # Errors
///
/// This function fails to set the global logger if one has already been set.
pub fn try_init_custom_env(environment_variable_name: &str) -> Result<(), log::SetLoggerError> {
    let mut builder = formatted_builder()?;

    if let Ok(s) = ::std::env::var(environment_variable_name) {
        builder.parse(&s);
    }

    builder.try_init()
}

/// Returns a `env_logger::Builder` for further customization.
///
/// This method will return a colored and formatted) `env_logger::Builder`
/// for further customization. Refer to env_logger::Build crate documentation
/// for further details and usage.
///
/// This should be called early in the execution of a Rust program, and the
/// global logger may only be initialized once. Future initialization attempts
/// will return an error.
///
/// # Errors
///
/// This function fails to set the global logger if one has already been set.
pub fn formatted_builder() -> Result<Builder, log::SetLoggerError> {
    let mut builder = Builder::new();
    let start_time = Instant::now();

    builder.format(move |f, record| {
        use std::io::Write;
        let target = record.target();

        let time = start_time.elapsed();
        let (color, level) = match record.level() {
            Level::Trace => (Color::Purple, " 🤓 T "),
            Level::Debug => (Color::Blue, " 🤔 D "),
            Level::Info => (Color::Green, " 😋 I "),
            Level::Warn => (Color::Yellow, " 😥 W "),
            Level::Error => (Color::Red, " 😡 E "),
        };

        let mut module_iter = target.split("::");
        let krate = module_iter.next();
        let path = module_iter.last();
        let target = format!(
            " {}{} ",
            krate.unwrap_or_default(),
            path.map(|s| format!(":{}", s)).unwrap_or_default()
        );

        SINCE_WIDTH_INCREASE.fetch_add(1, Ordering::Relaxed);
        let mut max_width = MAX_MODULE_WIDTH.load(Ordering::Relaxed);
        if max_width <= target.len() {
            MAX_MODULE_WIDTH.store(target.len(), Ordering::Relaxed);
            max_width = target.len();
            SINCE_WIDTH_INCREASE.store(0, Ordering::Relaxed);
        } else if SINCE_WIDTH_INCREASE.load(Ordering::Relaxed) > 5 {
            MAX_MODULE_WIDTH.store(target.len(), Ordering::Relaxed);
            max_width = target.len();
        }

        writeln!(
            f,
            "{}{}{}> {}",
            Style::new().on(color).fg(Color::White).paint(level),
            Style::new()
                .on(Color::White)
                .fg(Color::Black)
                .dimmed()
                .bold()
                .paint(format!(
                    " {:.2} ",
                    time.as_secs() as f64 + (f64::from(time.subsec_millis()) / 1000f64)
                )),
            Style::new()
                .bold()
                .paint(format!("{: <width$}", target, width = max_width)),
            format!("{}", record.args()).replace(
                "\n",
                &format!(
                    "\n{} ",
                    Style::new().on(color).fg(Color::White).paint(level)
                )
            )
        )
    });

    Ok(builder)
}