feat: logging

Author: DogeDark

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dioxus-logger"
-version = "0.1.2"
+version = "0.2.0"
 edition = "2021"
 description = "A logging utility to provide a standard interface whether you're targetting web, desktop, or mobile."
 repository = "https://github.com/DogeDark/dioxus-logger"

README.md

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

src/lib.rs

@@ -1,42 +1,42 @@
 use log::{LevelFilter, SetLoggerError};
-//use std::path::PathBuf;
 
-/*pub struct HttpConfig {
-    method: reqwest::Method,
-    url: String,
-    authorization_token: String,
-}
-
-pub enum OutputType {
-    Json,
-    Stdio,
-}
-
-pub struct FileSystemConfig {
-    file_name: String,
-    output_type: OutputType,
-    output_path: PathBuf,
-}*/
+/// The log level. E.g. ``INFO``
+const LEVEL: &str = "{LEVEL}";
+/// The file's path or crate name. E.g. ``dioxus-testing``
+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}";
 
 /// The primary logging struct that contains all runtime configuration.
 pub struct DioxusLogger {
-    //http_config: Option<HttpConfig>,
-    //file_system_config: Option<FileSystemConfig>,
     level_filter: LevelFilter,
+    format: &'static str,
 }
 
 impl DioxusLogger {
-    pub fn new(
-        level_filter: LevelFilter,
-        //file_system_config: Option<FileSystemConfig>,
-        //http_config: Option<HttpConfig>,
-    ) -> Self {
+    /// Create a new [`DioxusLogger`] struct to configure and build.
+    pub fn new(level_filter: LevelFilter) -> Self {
         Self {
-            //http_config,
-            //file_system_config,
             level_filter,
+            format: "[{LEVEL}] {PATH} - {ARGS}]",
         }
     }
+
+    /// Builds and initializes the logger with [`log`]
+    pub fn build(self) -> Result<(), SetLoggerError> {
+        let level = self.level_filter.clone();
+        log::set_boxed_logger(Box::new(self)).map(|()| log::set_max_level(level))
+    }
+
+    /// Allows you to define a custom format.
+    /// 
+    /// The available options are `{LEVEL}`, `{PATH}` and `{ARGS}`
+    /// 
+    /// 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;
+    }
 }
 
 impl log::Log for DioxusLogger {
@@ -49,7 +49,27 @@ impl log::Log for DioxusLogger {
             return;
         }
 
-        let formatted = format!("[{}] {} - {}", record.level(), record.module_path().unwrap_or(""), record.args());
+        // This is cursed
+        let formatted = self
+            .format
+            // LEVEL
+            .replace(LEVEL, record.level().as_str())
+            .to_owned()
+            // PATH
+            .replace(PATH, record.module_path().unwrap_or(""))
+            .to_owned()
+            // 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(all(
             not(target_family = "wasm"),
@@ -66,7 +86,7 @@ impl log::Log for DioxusLogger {
 }
 
 /// 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> {
-    let logger = DioxusLogger::new(level_filter);
-    log::set_boxed_logger(Box::new(logger)).map(|()| log::set_max_level(level_filter))
+    DioxusLogger::new(level_filter).build()
 }