feat: timestamp support

Author: DogeDark

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "rust-analyzer.cargo.features": "all",
+}

Cargo.toml

@@ -10,11 +10,11 @@ license = "MIT"
 keywords = ["dioxus", "log", "logging"]
 categories = ["development-tools::debugging"]
 
-#[features]
-#stdio = []
-#http_logging = ["dep:reqwest"]
+[features]
+timestamps = ["dep:time"]
 
 [dependencies]
 log = { version = "0.4", features = ["std"] }
+time = { version = "0.3.17", features = ["std", "wasm-bindgen"], optional = true }
 #reqwest = { version = "0.11", features = [] }
 web-sys = { version = "0.3.60", features = ["console"] }

README.md

@@ -28,11 +28,10 @@
 **Current & Planned Features**
 - [x] stdio logging (Web, Desktop) - Mobile to come
 - [x] Custom log format - Basic Implementation Finished
+- [x] Timestamps 
 - [ ] Sending logs over HTTP to an API
 - [ ] Logging to a file
 - [ ] Logging to [Sentry](https://sentry.io/)?
-- [ ] Timestamps 
-- [ ] Feature flags for faster compilation
 
 **This library is under development. Expect breaking changes.**
 

src/lib.rs

@@ -7,6 +7,8 @@ const PATH: &str = "{PATH}";
 /// The arguments passed through the log macro.
 /// E.g. the args from ``info!("hello")`` will be ``"hello"``
 const ARGS: &str = "{ARGS}";
+/// A timestamp of when the log was generated.
+const TIMESTAMP: &str = "{TIMESTAMP}";
 
 /// The primary logging struct that contains all runtime configuration.
 pub struct DioxusLogger {
@@ -17,9 +19,14 @@ pub struct DioxusLogger {
 impl DioxusLogger {
     /// Create a new [`DioxusLogger`] struct to configure and build.
     pub fn new(level_filter: LevelFilter) -> Self {
+        let format = "[{LEVEL}] {PATH} - {ARGS}]";
+
+        #[cfg(feature = "timestamps")]
+        let format = "[{TIMESTAMP} | {LEVEL}] {PATH} - {ARGS}]";
+
         Self {
             level_filter,
-            format: "[{LEVEL}] {PATH} - {ARGS}]",
+            format,
         }
     }
 
@@ -30,9 +37,9 @@ impl DioxusLogger {
     }
 
     /// Allows you to define a custom format.
-    /// 
-    /// The available options are `{LEVEL}`, `{PATH}` and `{ARGS}`
-    /// 
+    ///
+    /// The available options are `{LEVEL}`, `{PATH}`, `{ARGS}` and `{TIMESTAMP}`
+    ///
     /// Providing the format of `[{LEVEL}] {PATH} - {ARGS}]` will return something like `[INFO] dioxus_testing - this is my log message`
     pub fn use_format(&mut self, format: &'static str) {
         self.format = format;
@@ -61,15 +68,8 @@ impl log::Log for DioxusLogger {
             // ARGS
             .replace(ARGS, record.args().to_string().as_str());
 
-        /*
-        // The old format, not customizable
-        let formatted = format!(
-            "[{}] {} - {}",
-            record.level(),
-            record.module_path().unwrap_or(""),
-            record.args()
-        );
-        */
+        #[cfg(feature = "timestamps")]
+        let formatted = format_timestamp(formatted);
 
         #[cfg(all(
             not(target_family = "wasm"),
@@ -85,6 +85,13 @@ impl log::Log for DioxusLogger {
     fn flush(&self) {}
 }
 
+fn format_timestamp(formatted: String) -> String {
+    let timestamp = time::OffsetDateTime::now_utc();
+    formatted
+        .to_owned()
+        .replace(TIMESTAMP, timestamp.to_string().as_str())
+}
+
 /// Initialize `log` and `dioxus-logger` with a specified filter.
 /// For more advanced configuration, build the logger through the [`DioxusLogger`] struct.
 pub fn init(level_filter: LevelFilter) -> Result<(), SetLoggerError> {