Use argument based logging configuration

- Use argument based logging configuration rather than one provided from
  the environment
- Drop "lib.rs" from previous refactor
- Remove "thiserror" and rely on "anyhow" purely
- Update dependencies

Signed-off-by: Nick Gerace <nickagerace@gmail.com>

Author: nickgerace

Cargo.lock

@@ -22,6 +22,7 @@ strip = true
 [dependencies]
 anyhow = { version = "1.0", features = ["backtrace"] }
 clap = { version = "4.5", features = ["derive"] }
+clap-verbosity-flag = "3.0.2"
 env_logger = { version = "0.11", features = [ "humantime" ], default-features = false }
 git2 = { version = "0.20", default-features = false }
 log = "0.4"
@@ -30,7 +31,6 @@ remain = "0.2"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 termcolor = "1.4"
-thiserror = "2.0"
 toml = "0.8"
 user_dirs = "0.2"
 

Cargo.toml

@@ -1,6 +1,10 @@
 _default:
     @just --list
 
+# Build and run at the debug level in the parent directory
+run:
+    cargo run -- -vvv ..
+
 # Scan for potential bloat
 bloat:
     cargo bloat --release

justfile

@@ -1,28 +1,16 @@
 //! This module contains the functionality for generating reports.
 
-use rayon::prelude::*;
 use std::collections::BTreeMap;
 use std::path::Path;
+
+use anyhow::Result;
+use rayon::prelude::*;
 use target::TargetCollector;
-use thiserror::Error;
 
-use crate::repository_view::{RepositoryView, RepositoryViewError, RepositoryViewResult};
+use crate::repository_view::RepositoryView;
 
 mod target;
 
-#[allow(missing_docs)]
-#[remain::sorted]
-#[derive(Error, Debug)]
-pub enum CollectorError {
-    #[error(transparent)]
-    FromRepositoryView(#[from] RepositoryViewError),
-    #[error(transparent)]
-    FromStdIo(#[from] std::io::Error),
-}
-
-/// The result type used when multiple kinds of errors can be encountered during collection.
-pub type CollectorResult<T> = Result<T, CollectorError>;
-
 /// This type represents a [`BTreeMap`] using an optional [`String`] for keys, which represents the
 /// parent directory for a group of reports ([`Vec<RepositoryView>`]). The values corresponding to those keys
 /// are the actual groups of reports.
@@ -31,7 +19,7 @@ pub type CollectorResult<T> = Result<T, CollectorError>;
 /// sorted keys.
 pub type RepositoryCollection = BTreeMap<Option<String>, Vec<RepositoryView>>;
 
-type UnprocessedRepositoryView = RepositoryViewResult<RepositoryView>;
+type UnprocessedRepositoryView = Result<RepositoryView>;
 
 /// A unit struct that provides [`Self::run()`], which is used to generated [`RepositoryCollection`].
 #[derive(Debug)]
@@ -43,24 +31,18 @@ impl RepositoryCollector {
         path: &Path,
         include_email: bool,
         include_submodules: bool,
-    ) -> CollectorResult<RepositoryCollection> {
+    ) -> Result<RepositoryCollection> {
         let unprocessed = TargetCollector::run(path.to_path_buf())?
             .par_iter()
             .map(|path| RepositoryView::new(path, include_email, include_submodules))
             .collect::<Vec<UnprocessedRepositoryView>>();
 
         let mut processed = RepositoryCollection::new();
         for maybe_view in unprocessed {
-            match maybe_view {
-                Ok(view) => {
-                    if let Some(mut views) =
-                        processed.insert(view.parent.clone(), vec![view.clone()])
-                    {
-                        views.push(view.clone());
-                        processed.insert(view.parent, views);
-                    }
-                }
-                Err(e) => return Err(e.into()),
+            let view = maybe_view?;
+            if let Some(mut views) = processed.insert(view.parent.clone(), vec![view.clone()]) {
+                views.push(view.clone());
+                processed.insert(view.parent, views);
             }
         }
         Ok(processed)

src/collector.rs

@@ -9,7 +9,7 @@ use std::{env, fs};
 /// This struct is the actual config type consumed through the codebase. It is boostrapped via its
 /// public methods and uses [`EntryConfig`], a private struct, under the hood in order to
 /// deserialize empty, non-existent, partial, and complete config files.
-#[derive(Serialize)]
+#[derive(Debug, Serialize)]
 pub struct Config {
     /// The paths that `gfold` will traverse and collect results from.
     pub paths: Vec<PathBuf>,
@@ -131,7 +131,7 @@ struct EntryConfig {
 /// In summary, while this setting is primarily for cosmetics, it may also affect runtime
 /// performance based on what needs to be displayed.
 #[remain::sorted]
-#[derive(Serialize, Deserialize, Clone, Copy, ValueEnum)]
+#[derive(Debug, Serialize, Deserialize, Clone, Copy, ValueEnum)]
 pub enum DisplayMode {
     /// Informs the caller to display results in the classic format.
     Classic,
@@ -147,7 +147,7 @@ pub enum DisplayMode {
 
 /// Set the color mode of results printed to `stdout`.
 #[remain::sorted]
-#[derive(Serialize, Deserialize, Clone, Copy, ValueEnum)]
+#[derive(Debug, Serialize, Deserialize, Clone, Copy, ValueEnum)]
 pub enum ColorMode {
     /// Attempt to display colors as intended (default behavior).
     Always,

src/config.rs

@@ -1,28 +1,24 @@
 //! This module contains the functionality for displaying reports to `stdout`.
 
+use std::io;
+use std::path::Path;
+
+use anyhow::{anyhow, Result};
 use color::ColorHarness;
-use gfold::RepositoryCollection;
 use log::debug;
 use log::warn;
-use std::io;
-use std::path::{Path, PathBuf};
-use thiserror::Error;
 
+use crate::collector::RepositoryCollection;
 use crate::config::{ColorMode, DisplayMode};
 
-mod color;
+// TODO(nick): make this module private.
+pub mod color;
 
 const PAD: usize = 2;
 const NONE: &str = "none";
 
-#[remain::sorted]
-#[derive(Error, Debug)]
-pub enum DisplayError {
-    #[error("could not convert path (Path) to &str: {0}")]
-    PathToStrConversionFailure(PathBuf),
-}
-
 /// This struct is used for displaying the contents of a [`RepositoryCollection`] to `stdout`.
+#[derive(Debug)]
 pub struct DisplayHarness {
     display_mode: DisplayMode,
     color_mode: ColorMode,
@@ -37,7 +33,7 @@ impl DisplayHarness {
     }
 
     /// This function chooses the display execution function based on the [`DisplayMode`] provided.
-    pub fn run(&self, reports: &RepositoryCollection) -> anyhow::Result<()> {
+    pub fn run(&self, reports: &RepositoryCollection) -> Result<()> {
         match self.display_mode {
             DisplayMode::Standard => Self::standard(reports, self.color_mode, false)?,
             DisplayMode::StandardAlphabetical => Self::standard(reports, self.color_mode, true)?,
@@ -52,7 +48,7 @@ impl DisplayHarness {
         reports: &RepositoryCollection,
         color_mode: ColorMode,
         alphabetical_sort_only: bool,
-    ) -> anyhow::Result<()> {
+    ) -> Result<()> {
         debug!("detected standard display mode");
         let mut all_reports = Vec::new();
         for grouped_report in reports {
@@ -76,9 +72,9 @@ impl DisplayHarness {
             let full_path = Path::new(&parent).join(&report.name);
             let full_path_formatted = format!(
                 " ~ {}",
-                full_path
-                    .to_str()
-                    .ok_or_else(|| DisplayError::PathToStrConversionFailure(full_path.clone()))?
+                full_path.to_str().ok_or(anyhow!(
+                    "could not convert path (Path) to &str: {full_path:?}"
+                ))?
             );
             color_harness.write_gray(&full_path_formatted, true)?;
 

src/display.rs

@@ -1,19 +1,20 @@
 //! This module provides a harness for non-trivial displays of information to `stdout`.
 
-use gfold::Status;
 use std::io;
 use std::io::Write;
 use termcolor::{Color, ColorChoice, ColorSpec, StandardStream, WriteColor};
 
-use crate::config::ColorMode;
+use crate::{config::ColorMode, status::Status};
 
 /// This harness provides methods to write to `stdout`. It maps the internal [`ColorMode`] type to
 /// our dependency's [`ColorChoice`] type due to discrepancies in behavior and naming.
+#[derive(Debug)]
 pub struct ColorHarness {
     color_choice: ColorChoice,
 }
 
 impl ColorHarness {
+    /// Creates a new color harness.
     pub fn new(color_mode: ColorMode) -> Self {
         Self {
             color_choice: match &color_mode {