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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
//!
//! Dead simple log utils for debug in Rust.
//!
//! - 🦀 Enabled only in debug mode when DEBUG environment variable is set
//! - 🔊 Only perform log in files whose paths match `DEBUG="filename"`. Match all by
//! using `DEBUG=""`, or `DEBUG="*"`
//! - 📦 Group output with `debug_group`
//! - 📤 WASM support. It will use the console API.
//!
//! The output log is super easy to read on VS Code with sticky scroll enabled.
//!
//! <img src="https://user-images.githubusercontent.com/18425020/202741062-0467b470-32ca-4a23-b280-73fa7d4c7868.gif" width="600"/>
//!
//! # Example
//!
//! ```rust
//! use debug_log::{debug_dbg, debug_log, group};
//! group!("A Group");
//! {
//! group!("Sub A Group");
//! let arr: Vec<_> = (0..3).collect();
//! debug_dbg!(&arr);
//! {
//! group!("Sub Sub A Group");
//! debug_dbg!(&arr);
//! }
//! debug_log!("Hi");
//! debug_dbg!(&arr);
//! }
//!
//! {
//! group!("B Group");
//! debug_log!("END");
//! }
//! ```
//!
//! Run with `DEBUG=* cargo run`
//!
//! Output
//!
//! ```log
//! A Group {
//! Sub A Group {
//! [src/lib.rs:144] &arr = [
//! 0,
//! 1,
//! 2,
//! ]
//! Sub Sub A Group {
//! [src/lib.rs:147] &arr = [
//! 0,
//! 1,
//! 2,
//! ]
//! }
//! [src/lib.rs:150] Hi
//! [src/lib.rs:151] &arr = [
//! 0,
//! 1,
//! 2,
//! ]
//! }
//! B Group {
//! [src/lib.rs:157] END
//! }
//! }
//! ```
#[cfg(all(debug_assertions))]
mod debug {
use std::sync::Mutex;
use once_cell::sync::Lazy;
static DEBUG: Lazy<Mutex<Option<String>>> =
Lazy::new(|| Mutex::new(std::option_env!("DEBUG").map(|x| x.to_owned())));
static LEVELS: Mutex<Vec<String>> = Mutex::new(Vec::new());
/// Change the DEBUG value to filter tests
pub fn set_debug(s: &str) {
*DEBUG.lock().unwrap() = Some(s.to_owned());
}
pub mod console {
#[cfg(all(feature = "wasm", target_arch = "wasm32"))]
use wasm_bindgen::prelude::wasm_bindgen;
#[cfg(all(feature = "wasm", target_arch = "wasm32"))]
#[wasm_bindgen]
extern "C" {
// Use `js_namespace` here to bind `console.log(..)` instead of just
// `log(..)`
#[wasm_bindgen(js_namespace = console)]
pub fn log(s: &str);
#[wasm_bindgen(js_namespace = console)]
pub fn group(s: &str);
#[wasm_bindgen(js_namespace = console)]
pub fn groupEnd();
}
#[cfg(not(all(feature = "wasm", target_arch = "wasm32")))]
pub use patch::*;
#[cfg(not(all(feature = "wasm", target_arch = "wasm32")))]
mod patch {
pub fn log(s: &str) {
eprintln!("{}", s);
}
pub fn group(s: &str) {
eprintln!("{}", s);
}
pub fn groupEnd() {}
}
}
#[doc(hidden)]
#[macro_export]
macro_rules! inner_println {
($($arg:tt)+) => {{
if $crate::should_log(&file!()) {
if cfg!(all(feature = "wasm", target_arch = "wasm32")) {
let s = format!($($arg)+);
$crate::console::log(&s);
} else {
eprintln!($($arg)+);
}
}
}};
() => {
if $crate::should_log(&file!()) {
if cfg!(all(feature = "wasm", target_arch = "wasm32")) {
$crate::console::log("");
} else {
eprintln!();
}
}
};
}
#[doc(hidden)]
pub fn get_level() -> usize {
LEVELS.lock().unwrap().len()
}
#[doc(hidden)]
pub fn indent(name: &str) {
let space = format!("{}", " ".repeat(get_level()));
inner_println!("{}{} {{", space, name);
LEVELS.lock().unwrap().push(name.to_string())
}
#[doc(hidden)]
pub fn outdent() {
LEVELS.lock().unwrap().pop();
let space = format!("{}", " ".repeat(get_level()));
inner_println!("{}}}", space);
}
#[doc(hidden)]
pub fn dbg<T: std::fmt::Debug>(value: T, name: &str, line: &str) {
let s = format!("{:#?}", value);
let mut ans = String::new();
ans.push_str(&" ".repeat(get_level()));
ans.push_str(format!("[{}] {} = ", line, name).as_str());
for (i, line) in s.split('\n').enumerate() {
if i != 0 {
ans.push_str(&" ".repeat(get_level()));
}
ans.push_str(line);
ans.push('\n')
}
if ans.ends_with('\n') {
ans.drain(ans.len() - 1..);
}
inner_println!("{}", ans);
}
#[doc(hidden)]
pub fn prepend_indent(s: String) -> String {
let mut ans = String::new();
for (i, line) in s.split('\n').enumerate() {
if i != 0 {
ans.push_str(&" ".repeat(get_level()));
}
ans.push_str(line);
ans.push('\n')
}
ans
}
#[doc(hidden)]
pub fn should_log(file: &str) -> bool {
let lock = DEBUG.lock().unwrap();
lock.as_ref()
.map_or(false, |x| !x.is_empty() && (x == "*" || file.contains(x)))
}
/// Group the following logs until the guard is dropped
#[macro_export]
macro_rules! group {
($($arg:tt)*) => {
let __debug_log_group_guard = {
let line = format!("{}:{}", file!(), line!());
let mut guard = None;
if $crate::should_log(&line) {
$crate::indent(&format!($($arg)*));
guard = Some($crate::GroupGuard);
}
guard
};
};
() => {
let mut __debug_log_group_guard= None;
if $crate::should_log(&file!()) {
$crate::indent("".to_string());
__debug_log_group_guard = Some($crate::GroupGuard);
}
};
}
#[doc(hidden)]
pub struct GroupGuard;
impl Drop for GroupGuard {
fn drop(&mut self) {
crate::outdent();
}
}
/// It can be filtered by DEBUG env and can only log on debug mode
#[macro_export]
macro_rules! debug_dbg {
($($val:expr),+ $(,)?) => {
let line = format!("{}:{}", file!(), line!());
if $crate::should_log(&line) {
($($crate::dbg($val, stringify!($val), &line)),+,);
}
};
() => {
let line = format!("{}:{}", file!(), line!());
if $crate::should_log(&line) {
let space = format!("{}", " ".repeat($crate::get_level()));
$crate::inner_println!("{}[{}] ",space, line);
}
}
}
/// Use it like println!(). Except it can be filtered by DEBUG env and can only log on debug mode
#[macro_export]
macro_rules! debug_log {
($($arg:tt)*) => {{
let line = format!("{}:{}", file!(), line!());
if $crate::should_log(&line) {
let prefix = format!("{}[{}] ", " ".repeat($crate::get_level()), line);
let s = format!($($arg)*);
$crate::inner_println!("{}{}", prefix, $crate::prepend_indent(s));
}
}};
() => {
if $crate::should_log(&file!()) {
$crate::inner_println();
}
};
}
}
#[cfg(not(debug_assertions))]
mod debug {
pub fn set_debug(s: &str) {}
/// Group the following logs until the guard is dropped
#[macro_export]
macro_rules! group {
($($arg:tt)*) => {
None
};
() => {
None
};
}
/// Use it like println!(). Except it can be filtered by DEBUG env and can only log on debug mode
#[macro_export]
macro_rules! debug_log {
($($arg:tt)*) => {{}};
() => {};
}
/// It's just dbg!() with indent and can be filtered by DEBUG env
#[macro_export]
macro_rules! debug_dbg {
($($val:expr),+ $(,)?) => {};
() => {};
}
#[doc(hidden)]
pub struct GroupGuard;
}
pub use debug::*;
#[cfg(test)]
mod tests {
use crate::{debug_dbg, debug_log, group};
#[test]
/// Run this test with
/// DEBUG=* cargo test -- --nocapture &> data.log
fn it_works() {
group!("A Group");
group!("C Group");
{
group!("Sub A Group");
let arr: Vec<_> = (0..3).collect();
debug_dbg!(&arr);
{
group!("Sub Sub A Group");
debug_dbg!(&arr);
}
debug_log!("Hi");
debug_dbg!(&arr);
}
{
group!("B Group");
debug_log!("END");
}
}
}