Merge pull request #126 from shimaowo/smw_customizable_paris_formatting

[feat] Add set_enable_paris_formatting() ConfigBuilder method to control whether…

Cargo.toml

@@ -26,6 +26,6 @@ local-offset = ["time/local-offset"]
 [dependencies]
 log = { version = "0.4.*", features = ["std"] }
 termcolor = { version = "1.1.*", optional = true }
-paris = { version = "~1.5", optional = true }
+paris = { version = "~1.5.12", optional = true }
 ansi_term = { version = "0.12", optional = true }
 time = { version = "0.3.7", features = ["formatting", "macros"] }

examples/custom_colors.rs

@@ -1,4 +1,4 @@
-#[cfg(all(feature = "termcolor", not(feature = "paris")))]
+#[cfg(feature = "termcolor")]
 use log::*;
 #[cfg(feature = "termcolor")]
 use simplelog::*;

examples/default_colors.rs

@@ -1,4 +1,4 @@
-#[cfg(all(feature = "termcolor", not(feature = "paris")))]
+#[cfg(feature = "termcolor")]
 use log::*;
 #[cfg(feature = "termcolor")]
 use simplelog::*;

examples/rgb_colors.rs

@@ -1,8 +1,4 @@
-#[cfg(all(
-    not(target_family = "windows"),
-    feature = "termcolor",
-    not(feature = "paris")
-))]
+#[cfg(all(not(target_family = "windows"), feature = "termcolor"))]
 use log::*;
 #[cfg(all(not(target_family = "windows"), feature = "termcolor"))]
 use simplelog::*;

examples/usage.rs

@@ -1,4 +1,3 @@
-#[cfg(not(feature = "paris"))]
 use log::*;
 use simplelog::*;
 

src/config.rs

@@ -86,6 +86,8 @@ pub struct Config {
     #[cfg(feature = "termcolor")]
     pub(crate) level_color: [Option<Color>; 6],
     pub(crate) write_log_enable_colors: bool,
+    #[cfg(feature = "paris")]
+    pub(crate) enable_paris_formatting: bool,
 }
 
 /// Builder for the Logger Configurations (`Config`)
@@ -242,6 +244,15 @@ impl ConfigBuilder {
         self
     }
 
+    /// set if you want paris formatting to be applied to this logger (default is On)
+    ///
+    /// If disabled, paris markup and formatting will be stripped.
+    #[cfg(feature = "paris")]
+    pub fn set_enable_paris_formatting(&mut self, enable_formatting: bool) -> &mut ConfigBuilder {
+        self.0.enable_paris_formatting = enable_formatting;
+        self
+    }
+
     /// Add allowed target filters.
     /// If any are specified, only records from targets matching one of these entries will be printed
     ///
@@ -339,6 +350,9 @@ impl Default for Config {
                 Some(Color::Cyan),   // Debug
                 Some(Color::White),  // Trace
             ],
+
+            #[cfg(feature = "paris")]
+            enable_paris_formatting: true,
         }
     }
 }

src/lib.rs

@@ -39,15 +39,12 @@ pub use termcolor::{Color, ColorChoice};
 pub use log::{Level, LevelFilter};
 
 use log::Log;
-#[cfg(all(test, not(feature = "paris")))]
+#[cfg(test)]
 use log::*;
 
-#[cfg(feature = "paris")]
-pub(crate) mod paris_macros;
 #[cfg(feature = "paris")]
 #[doc(hidden)]
 pub mod __private {
-    pub use log;
     pub use paris;
 }
 

src/loggers/logging.rs

@@ -57,7 +57,10 @@ where
         write_location(record, write)?;
     }
 
-    write_args(record, write)
+    #[cfg(feature = "paris")]
+    return write_args(record, write, config.enable_paris_formatting);
+    #[cfg(not(feature = "paris"))]
+    return write_args(record, write);
 }
 
 #[inline(always)]
@@ -209,6 +212,24 @@ where
 }
 
 #[inline(always)]
+#[cfg(feature = "paris")]
+pub fn write_args<W>(record: &Record<'_>, write: &mut W, with_colors: bool) -> Result<(), Error>
+where
+    W: Write + Sized,
+{
+    writeln!(
+        write,
+        "{}",
+        crate::__private::paris::formatter::format_string(
+            format!("{}", record.args()),
+            with_colors
+        )
+    )?;
+    Ok(())
+}
+
+#[inline(always)]
+#[cfg(not(feature = "paris"))]
 pub fn write_args<W>(record: &Record<'_>, write: &mut W) -> Result<(), Error>
 where
     W: Write + Sized,

src/loggers/termlog.rs

@@ -171,6 +171,9 @@ impl TermLogger {
             write_location(record, term_lock)?;
         }
 
+        #[cfg(feature = "paris")]
+        write_args(record, term_lock, self.config.enable_paris_formatting)?;
+        #[cfg(not(feature = "paris"))]
         write_args(record, term_lock)?;
 
         // The log crate holds the logger as a `static mut`, which isn't dropped