Switch to an actual, standard logging system

Author: msuchane

Cargo.lock

@@ -14,8 +14,9 @@ categories = ["command-line-utilities", "text-processing"]
 
 [dependencies]
 clap = "2"
-colored = "2"
 regex = "1"
+log = "0.4"
+simplelog = "0.10"
 
 
 [package.metadata.rpm.cargo]

Cargo.toml

@@ -5,10 +5,12 @@ use clap::{
     ArgMatches,
 };
 
+use log::info;
+
 /// Define the command-line arguments and return them as the `clap::ArgMatches` struct.
 pub fn get_args() -> ArgMatches<'static> {
     // Define command-line options
-    App::new(crate_name!())
+    let matches = App::new(crate_name!())
         .version(crate_version!())
         .author(crate_authors!())
         .about(crate_description!())
@@ -102,5 +104,11 @@ pub fn get_args() -> ArgMatches<'static> {
                 .value_name("directory")
                 .help("Save the generated files in this directory"),
         )
-        .get_matches()
+        .get_matches();
+
+    if matches.is_present("detect-directory") {
+        info!("The `--detect-directory` (`-D`) option is now enabled by default.");
+    }
+
+    matches
 }

src/cmd_line.rs

@@ -0,0 +1,21 @@
+use simplelog::{ColorChoice, ConfigBuilder, LevelFilter, TerminalMode, TermLogger};
+
+/// This function initializes the `simplelog` logging system, which plugs into the `log`
+/// infrastructure. The function returns nothing. It only affects the global state when it runs.
+pub fn initialize_logger() {
+    let config = ConfigBuilder::new()
+        // Display a time stamp only for the debug and more verbose levels.
+        .set_time_level(LevelFilter::Debug)
+        .build();
+
+    TermLogger::init(
+        // The default verbosity level is Info because newdoc displays the include statement
+        // at that level.
+        LevelFilter::Info,
+        config,
+        // Mixed mode prints errors to stderr and info to stdout. Not sure about the other levels.
+        TerminalMode::Mixed,
+        // Try to use color if possible.
+        ColorChoice::Auto
+    ).expect("Failed to configure the terminal logging.");
+}

src/logging.rs

@@ -1,4 +1,5 @@
 mod cmd_line;
+mod logging;
 mod module;
 mod write;
 
@@ -16,11 +17,9 @@ pub struct Options {
 }
 
 fn main() {
-    let cmdline_args = cmd_line::get_args();
+    logging::initialize_logger();
 
-    if cmdline_args.is_present("detect-directory") {
-        eprintln!("I: The `--detect-directory` (`-D`) option is now enabled by default.");
-    }
+    let cmdline_args = cmd_line::get_args();
 
     // Set current options based on the command-line options
     let options = Options {

src/main.rs

@@ -2,7 +2,7 @@ use std::fs;
 use std::io::{self, Write};
 use std::path::PathBuf;
 
-use colored::*;
+use log::{error, info, warn};
 
 use crate::module::Module;
 use crate::Options;
@@ -17,11 +17,8 @@ impl Module {
         // If the target file already exists, just print out an error
         if full_path.exists() {
             // A prompt enabling the user to overwrite the existing file
-            eprintln!(
-                "{}",
-                format!("W: File already exists: {}", full_path.display()).yellow()
-            );
-            eprint!("   Do you want to overwrite it? [y/N] ");
+            warn!("File already exists: {}", full_path.display());
+            warn!("Do you want to overwrite it? [y/N] ");
             // We must manually flush the buffer or else the printed string doesn't appear.
             // The buffer otherwise waits for a newline.
             io::stdout().flush().unwrap();
@@ -34,10 +31,10 @@ impl Module {
 
             match answer.trim().to_lowercase().as_str() {
                 "y" | "yes" => {
-                    eprintln!("   → Rewriting the file.");
+                    warn!("→ Rewriting the file.");
                 }
                 _ => {
-                    eprintln!("   → Preserving the existing file.");
+                    info!("→ Preserving the existing file.");
                     // Break from generating this particular module.
                     // Other modules that might be in the queue will be generated on next iteration.
                     return;
@@ -50,12 +47,12 @@ impl Module {
         match result {
             // If the write succeeds, print the include statement
             Ok(()) => {
-                eprintln!("‣  File generated: {}", full_path.display());
-                eprintln!("   {}", self.include_statement);
+                info!("‣ File generated: {}", full_path.display());
+                info!("  {}", self.include_statement);
             }
             // If the write fails, print why it failed
             Err(e) => {
-                eprintln!("{}", format!("E: Failed to write the file: {}", e).red());
+                error!("Failed to write the file: {}", e);
             }
         }
     }