feat: add tracing

Author: dsully

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "magic-opener"
-version = "0.3.1"
+version = "0.3.2"
 authors = ["Dan Sully"]
 edition = "2024"
 description = "An 'open' replacement that tries to do the right thing."
@@ -16,12 +16,14 @@ name = "open"
 path = "src/main.rs"
 
 [dependencies]
-clap = { version = "^4.5", default-features = false, features = [
+clap = { version = "4.5", default-features = false, features = [
   "help",
   "std",
   "usage",
 ] }
 thiserror = "2"
+tracing = "0.1.41"
+tracing-subscriber = { version = "0.3.20", features = ["env-filter"] }
 
 [dev-dependencies]
 testresult = "0"

Cargo.toml

@@ -10,6 +10,9 @@ mod parser;
 mod repo;
 
 use repo::{GitRepository, RepositoryError};
+use tracing::debug;
+use tracing_subscriber::prelude::*;
+use tracing_subscriber::{EnvFilter, fmt};
 
 const LOCALHOST: &str = "localhost";
 const OPEN: &str = "/usr/bin/open";
@@ -27,6 +30,8 @@ fn expand_tilde(path: &str) -> String {
 }
 
 fn main() {
+    tracing_subscriber::registry().with(fmt::layer()).with(EnvFilter::from_default_env()).init();
+
     let cli = ClapCommand::new(env!("CARGO_PKG_NAME"))
         .version(env!("CARGO_PKG_VERSION"))
         .author(env!("CARGO_PKG_AUTHORS"))
@@ -65,6 +70,8 @@ fn main() {
         }
     };
 
+    debug!("Remote path resolved to: {}", remote_path);
+
     if remote_path.starts_with('-') {
         let command = if remote_path == "--help" { vec!["-h".to_string()] } else { paths };
 
@@ -113,5 +120,7 @@ fn main() {
         args.insert(0, "--background");
     }
 
+    debug!("Opening with args: {:?}", args);
+
     let _ = Command::new(OPEN).args(&args).exec();
 }

src/main.rs

@@ -1,8 +1,9 @@
 use std::path::{Path, PathBuf};
 use std::process::{Command, ExitStatus, Stdio};
-use std::{fmt, str};
+use std::str;
 
 use thiserror::Error;
+use tracing::debug;
 
 use crate::parser::parse_git_url;
 
@@ -146,25 +147,31 @@ impl GitRepository {
     pub fn url(current_dir: &str, paths: &[String]) -> Result<String, RepositoryError> {
         let is_git = is_git_repo(current_dir);
 
+        debug!("is_git_repo({current_dir}) = {is_git}");
+
         let join_paths = || match paths.join(" ") {
             path if path == "." => current_dir.to_string(),
             path => path,
         };
 
         if !is_git {
+            debug!("Not a Git repository; returning joined paths: {}", join_paths());
             return Ok(join_paths());
         }
 
         let r = Self::from_path(current_dir)?;
 
         if paths.is_empty() {
+            debug!("No additional paths; returning repository URL: {}", r.http_url());
             return Ok(r.http_url());
         }
 
         if paths.len() == 1 {
             let arg = &paths[0];
             let is_commit = is_valid_commit_hash(arg);
 
+            debug!("is_commit_hash({arg}) = {is_commit}");
+
             if is_commit || is_pr_number(arg) {
                 return if is_commit {
                     match r.pr_for_commit(arg) {
@@ -181,18 +188,6 @@ impl GitRepository {
     }
 }
 
-impl fmt::Debug for GitRepository {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self.http_url())
-    }
-}
-
-impl fmt::Display for GitRepository {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        f.write_str(&self.http_url())
-    }
-}
-
 fn git(path: impl AsRef<Path>, args: &[&str]) -> Result<String, RepositoryError> {
     let out = Command::new("git")
         .args(args)