Merge pull request #19 from rafaeldelboni/feat/add-verbose-mode

feat: Adds verbose mode

README.md

@@ -26,7 +26,7 @@ Tool for managing dotfiles directories; Heavily based on [rcm](http://thoughtbot
   - [x] Option to always override (-f --force)
   - [x] Add version command (-V --version)
   - [x] Add dry-run command (-D --dry-run)
-  - [ ] Add verbosity command (-v)
+  - [x] Add verbosity command (-v --verbose)
   - [ ] Add drop/delete command, this deletes dotfiles managed by paro (-d --down)
 - CI Pipeline to build releases
   - [ ] Linux (x86_64)
@@ -90,6 +90,9 @@ Do not install files that match <file-pattern>. Tagged files go in a directory n
 the tag, prefixed with tag-. Therefore, files under .dotfiles/tag-git are only installed
 when installing using the git tag. This can be repeated with additional patterns.
 
+#### -v, --verbose
+Make the operation more talkative. This can be repeated for more verbosity.
+
 #### -V, --version
 Print version information
 

src/actions.rs

@@ -36,8 +36,9 @@ impl Actions {
   }
 
   fn log(&mut self, level: Log, message: String) {
-    // TODO replace 4 with verbosity settings in clap
-    if (level as u16 <= 4) || self.file_actions.settings.dry_run {
+    if (level as u8 <= self.file_actions.settings.verbose)
+      || self.file_actions.settings.dry_run
+    {
       self.stdio.writeln(message);
     }
   }

src/parsers/clap.rs

@@ -143,6 +143,17 @@ impl ClapParser {
              A simulated or practice performance; rehearsal.",
           )
           .action(ArgAction::SetTrue),
+      )
+      .arg(
+        Arg::new("verbose")
+          .short('v')
+          .long("verbose")
+          .help("Make the operation more talkative")
+          .long_help(
+            "Make the operation more talkative. \
+            This can be repeated for more verbosity.",
+          )
+          .action(ArgAction::Count),
       );
 
     Self { clap: app }
@@ -164,6 +175,7 @@ impl ClapParser {
       force: matches.get_one::<bool>("force").copied().unwrap(),
       down: matches.get_one::<bool>("down").copied().unwrap(),
       dry_run: matches.get_one::<bool>("dry-run").copied().unwrap(),
+      verbose: matches.get_one::<u8>("verbose").copied().unwrap(),
     }
   }
 }
@@ -210,6 +222,7 @@ mod tests {
     assert_eq!(settings.force, false);
     assert_eq!(settings.down, false);
     assert_eq!(settings.dry_run, false);
+    assert_eq!(settings.verbose, 0);
   }
 
   #[test]
@@ -278,4 +291,10 @@ mod tests {
     ]);
     assert_eq!(settings.destination, "/new/home2");
   }
+
+  #[test]
+  fn test_clap_verbose() {
+    let settings = ClapParser::new().into_settings(vec!["paro", "-vv"]);
+    assert_eq!(settings.verbose, 2);
+  }
 }

src/parsers/config.rs

@@ -35,6 +35,8 @@ impl ConfigParser {
         .unwrap()
         .set_default("dry-run", false)
         .unwrap()
+        .set_default("verbose", 0)
+        .unwrap()
         .build()
         .unwrap(),
     }
@@ -66,6 +68,7 @@ mod tests {
     assert_eq!(settings.force, false);
     assert_eq!(settings.down, false);
     assert_eq!(settings.dry_run, false);
+    assert_eq!(settings.verbose, 0);
   }
 
   #[test]
@@ -121,4 +124,10 @@ mod tests {
     let settings = ConfigParser::new(&config_file()).into_settings();
     assert_eq!(settings.dry_run, true);
   }
+
+  #[test]
+  fn test_config_verbose() {
+    let settings = ConfigParser::new(&config_file()).into_settings();
+    assert_eq!(settings.verbose, 2);
+  }
 }

src/settings.rs

@@ -23,6 +23,7 @@ pub struct Settings {
   pub force: bool,
   pub down: bool,
   pub dry_run: bool,
+  pub verbose: u8,
 }
 
 impl Settings {
@@ -61,6 +62,7 @@ impl Settings {
       force: self.force,
       down: self.down,
       dry_run: self.dry_run,
+      verbose: self.verbose,
     }
   }
 
@@ -99,6 +101,7 @@ impl Settings {
       force: self.force || other.force,
       down: self.down || other.down,
       dry_run: self.dry_run || other.dry_run,
+      verbose: self.verbose | other.verbose,
     }
   }
 
@@ -130,6 +133,7 @@ impl Default for Settings {
       force: false,
       down: false,
       dry_run: false,
+      verbose: 0,
     }
   }
 }
@@ -154,6 +158,7 @@ mod tests {
       force: true,
       down: true,
       dry_run: true,
+      verbose: 2,
     };
 
     let settings_with_defaults = settings_1.clone().with_defaults();
@@ -166,6 +171,7 @@ mod tests {
     assert_eq!(settings_with_defaults.force, settings_1.force);
     assert_eq!(settings_with_defaults.down, settings_1.down);
     assert_eq!(settings_with_defaults.dry_run, settings_1.dry_run);
+    assert_eq!(settings_with_defaults.verbose, settings_1.verbose);
   }
 
   #[test]
@@ -181,6 +187,7 @@ mod tests {
       force: true,
       down: true,
       dry_run: true,
+      verbose: 2,
     };
     let settings_2 = Settings {
       tags: to_string_vec(vec!["t2", "t2"]),
@@ -192,6 +199,7 @@ mod tests {
       force: false,
       down: false,
       dry_run: false,
+      verbose: 0,
     };
 
     let merged_settings = settings_empty.merge(settings_1.clone());
@@ -204,6 +212,7 @@ mod tests {
     assert_eq!(merged_settings.force, settings_1.force);
     assert_eq!(merged_settings.down, settings_1.down);
     assert_eq!(merged_settings.dry_run, settings_1.dry_run);
+    assert_eq!(merged_settings.verbose, settings_1.verbose);
 
     let merged2_settings = settings_1.clone().merge(settings_2.clone());
     assert_eq!(
@@ -227,6 +236,7 @@ mod tests {
     assert_eq!(merged2_settings.force, settings_1.force);
     assert_eq!(merged2_settings.down, settings_1.down);
     assert_eq!(merged2_settings.dry_run, settings_1.dry_run);
+    assert_eq!(merged2_settings.verbose, settings_1.verbose);
   }
 
   #[test]

tests/settings.toml

@@ -7,3 +7,4 @@ hostname="hostname-in-config"
 force=true
 down=true
 dry-run=true
+verbose=2