allow custom colors, remove invalid categories from cargo config and bump ver (#13)

Author: SkwalExe

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.1.0
+- Allow custom colors
+
 # 1.0.0
 - Convert project to crate 🎉
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rust_logging"
-version = "1.0.0"
+version = "1.1.0"
 edition = "2021"
 authors = ["Léopold Koprivnik Ibghy, @SkwalExe <skwal.net@gmail.com>"]
 description = "A couple of functions to make logging in Rust easier."
@@ -10,7 +10,6 @@ homepage = "https://github.com/SkwalExe/rust-logging"
 repository = "https://github.com/SkwalExe/rust-logging"
 license = "MIT"
 keywords = ["rust",  "logging", "rust-logging", "logger"]
-categories = ["logging", "logger", "logs"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -9,7 +9,7 @@
 ```toml
 # Cargo.toml
 [dependencies]
-rust_logging = "1.0.0"
+rust_logging = "1.1.0"
 ```
 
 # Usage 📝
@@ -33,7 +33,7 @@ fn main() {
         log_file: "log.txt", // the file to log to when logging to a file
         highlight: true, // highlight text after ":" in the message
         ..Default::default() // the default values for the non specified settings
-    }
+    };
 
     let custom_logger = settings.get_logger();
 }
@@ -70,7 +70,7 @@ This can be disabled by setting the `highlight` field to `false` inside the cust
 let settings = LoggerOptions {
     highlight: false,
     ..Default::default()
-}
+};
 
 let logger = settings.get_logger();
 ```
@@ -116,13 +116,39 @@ let settings = LoggerOptions {
     info_icon: "ℹ️",
     success_icon: "✅",
     ..Default::default()
-}
+};
 
 let logger = settings.get_logger();
 ```
 
 ![](images/4.png)
 
+## Custom Colors 🎨
+
+You can change the colors of the messages by setting the `colors` field inside the custom settings.
+
+The value must be a `rust_logging::Colors` struct.
+
+```rust
+let my_colors = Colors {
+    // \x1b is the escape character (ASCII 27) and [xxm is the color 'code'
+    red: "\x1b[93m", // escape sequence for yellow foreground
+    bg_red: "\x1b[42m", // escape sequence for green background
+    ..Default::default()
+};
+
+let settings = LoggerOptions {
+    colors: my_colors,
+    ..Default::default()
+};
+
+let logger = settings.get_logger();
+
+logger.error("a command failed : hello");
+```
+
+![](images/6.png)
+
 ## Log file 📄
 
 You can specify the log file path to write the messages to with the `log_file` field.

images/6.png

@@ -3,32 +3,40 @@ use std::default::Default;
 use std::fmt::Display;
 
 pub struct Colors {
-    red: String,
-    green: String,
-    yellow: String,
-    cyan: String,
-    white: String,
-    reset: String,
-    bg_red: String,
-    bg_cyan: String,
-    bg_green: String,
-    bg_yellow: String,
+    pub red: String,
+    pub green: String,
+    pub yellow: String,
+    pub cyan: String,
+    pub white: String,
+    pub reset: String,
+    pub bg_red: String,
+    pub bg_cyan: String,
+    pub bg_green: String,
+    pub bg_yellow: String,
+}
+
+impl Default for Colors {
+    fn default() -> Self {
+        Colors {
+            red: "\x1b[91m".to_string(),
+            green: "\x1b[92m".to_string(),
+            yellow: "\x1b[93m".to_string(),
+            cyan: "\x1b[96m".to_string(),
+            white: "\x1b[97m".to_string(),
+            reset: "\x1b[0m".to_string(),
+            bg_red: "\x1b[41m".to_string(),
+            bg_cyan: "\x1b[46m".to_string(),
+            bg_green: "\x1b[42m".to_string(),
+            bg_yellow: "\x1b[43m".to_string(),
+        }
+    }
 }
 
 impl Colors {
     pub fn new() -> Colors {
         if stderr_isatty() && stdout_isatty() {
             Colors {
-                red: "\x1b[91m".to_string(),
-                green: "\x1b[92m".to_string(),
-                yellow: "\x1b[93m".to_string(),
-                cyan: "\x1b[96m".to_string(),
-                white: "\x1b[97m".to_string(),
-                reset: "\x1b[0m".to_string(),
-                bg_red: "\x1b[41m".to_string(),
-                bg_cyan: "\x1b[46m".to_string(),
-                bg_green: "\x1b[42m".to_string(),
-                bg_yellow: "\x1b[43m".to_string(),
+                ..Default::default()
             }
         } else {
             Colors {