feat: adding verbose CLI option (#232)

Author: DeveloperC286

README.md

@@ -20,7 +20,6 @@ A tooling and language agnostic utility to calculate the next semantic version b
    + [Usage - Consecutive Mode](#usage-consecutive-mode)
    + [Usage - Batch Mode](#usage-batch-mode)
    + [Usage - Git Environment Variables](#usage-git-environment-variables)
-   + [Usage - Logging](#usage-logging)
  * [CICD Examples](#cicd-examples)
    + [GitLab CI Rust Project Example](#gitlab-ci-rust-project-example)
      + [Via Cargo](#via-cargo)
@@ -127,12 +126,6 @@ When `${GIT_DIR}` is set, it takes precedence and Conventional Commits Next Vers
 When `${GIT_DIR}` is not set, Conventional Commits Next Version searches for a repository beginning in the current directory.
 
 
-### Usage - Logging
-The crates `pretty_env_logger` and `log` are used to provide logging.
-The environment variable `RUST_LOG` can be used to set the logging level.
-See [https://crates.io/crates/pretty_env_logger](https://crates.io/crates/pretty_env_logger) for more detailed documentation.
-
-
 ## CICD Examples
 ### GitLab CI Rust Project Example
 #### Via Cargo

src/cli/mod.rs

@@ -41,6 +41,12 @@ pub(crate) struct Arguments {
     )]
     pub(crate) current_version: Option<Version>,
 
+    #[arg(
+        long,
+        help = "Enable verbose output, respects RUST_LOG environment variable if set."
+    )]
+    pub(crate) verbose: bool,
+
     #[arg(
         help = "The Git reference from where to start taking the range of commits from till HEAD to lint. The range is inclusive of HEAD and exclusive of the provided reference. '-' indicates to read the standard input and lint the input as a Git commit message."
     )]

src/commits/commit/mod.rs

@@ -47,7 +47,7 @@ impl Commit {
     pub(super) fn from_git(commit: &git2::Commit) -> Commit {
         let message = match commit.message().map(|m| m.to_string()) {
             Some(message) => {
-                trace!(
+                debug!(
                     "Found the commit message {message:?} for the commit with the hash '{}'.",
                     commit.id()
                 );

src/commits/filters/mod.rs

@@ -69,7 +69,7 @@ impl Filters {
 
         if !self.commits_must_effect.is_empty() {
             let files_in_commit = get_all_files_changed_in_commit(repository, commit)?;
-            trace!(
+            debug!(
                 "Commit with the hash '{}' changes the files {files_in_commit:?}.",
                 commit.id(),
             );
@@ -83,7 +83,7 @@ impl Filters {
         for file_in_commit in files_in_commit {
             for filter in &self.commits_must_effect {
                 if file_in_commit.starts_with(filter) {
-                    trace!("The file {file_in_commit:?} affects the path {filter:?}.");
+                    debug!("The file {file_in_commit:?} affects the path {filter:?}.");
                     return true;
                 }
             }

src/commits/mod.rs

@@ -168,7 +168,11 @@ fn get_commits_till_head_from_oid(
         }
     }
 
-    debug!("Operating upon {} commits.", commits.len());
+    if commits.is_empty() {
+        bail!("No Git commits within the provided range.");
+    }
+
+    info!("Found {} commits within the provided range.", commits.len());
     Ok(Commits { commits })
 }
 
@@ -178,7 +182,7 @@ fn get_reference_oid(repository: &Repository, matching: &str) -> Result<Oid> {
         .context(format!(
             "Could not find a reference with the name {matching:?}."
         ))?;
-    trace!(
+    debug!(
         "Matched {:?} to the reference {:?}.",
         matching,
         reference.name().unwrap()
@@ -190,7 +194,7 @@ fn get_reference_oid(repository: &Repository, matching: &str) -> Result<Oid> {
 fn parse_to_oid(repository: &Repository, oid: &str) -> Result<Oid> {
     match oid.len() {
         1..=39 => {
-            trace!("Attempting to find a match for the short commit hash {oid:?}.");
+            debug!("Attempting to find a match for the short commit hash {oid:?}.");
             let matching_oid_lowercase = oid.to_lowercase();
 
             let mut revwalker = repository.revwalk()?;
@@ -202,6 +206,7 @@ fn parse_to_oid(repository: &Repository, oid: &str) -> Result<Oid> {
                         let oid_lowercase = oid.to_string().to_lowercase();
 
                         if oid_lowercase.starts_with(&matching_oid_lowercase) {
+                            debug!("Found a match for the short commit hash {oid:?}.");
                             return Some(oid);
                         }
 

src/main.rs

@@ -21,10 +21,16 @@ mod history_mode;
 const ERROR_EXIT_CODE: i32 = 1;
 
 fn main() {
-    pretty_env_logger::init();
-    trace!("Version {}.", env!("CARGO_PKG_VERSION"));
+    info!("Version {}.", env!("CARGO_PKG_VERSION"));
     let arguments = Arguments::parse();
-    trace!("The command line arguments provided are {arguments:?}.");
+    debug!("The command line arguments provided are {arguments:?}.");
+
+    // Set up logging: if verbose is true and RUST_LOG is not set, default to info level
+    if arguments.verbose && std::env::var("RUST_LOG").is_err() {
+        std::env::set_var("RUST_LOG", "info");
+    }
+
+    pretty_env_logger::init();
 
     if let Err(err) = run(arguments) {
         error!("{err:?}");