feat: add autocomplete for buddies aliases (#2)

for now this only works with the default `buddies_file` location
(`~/.config/git-squad/buddies.yaml`)

Author: ccntrq

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - allow passing multiple buddies to `with` command
 - allow passing multiple buddies to `without` command
+- add tab completions for buddies aliases
 
 ## 0.2.0 -- 2025-04-04
 

Cargo.lock

@@ -19,7 +19,7 @@ include = [
 
 [dependencies]
 clap = { version = "4.5", features = ["derive"] }
-clap_complete = "4.5"
+clap_complete = { version = "4.5", features = ["unstable-dynamic"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_yaml = "0.9"
 anyhow = "1.0"

Cargo.toml

@@ -12,6 +12,7 @@ manually edit commit templates.
 - Add and remove co-authors in the current git session
 - Automatically updates your git commit template
 - Simple command-line interface
+- Shell completions for commands and buddies
 
 ## Usage 
 
@@ -21,15 +22,16 @@ Manage co-authors in git commit messages with ease
 Usage: git-squad [OPTIONS] [COMMAND]
 
 Commands:
-  with     Add a buddy to the current session
-  without  Remove a buddy from the current session
-  alone    Remove all buddies from the current session
-  create   Create a new buddy
-  forget   Delete a buddy from the list of available buddies
-  info     List both active and available buddies
-  list     List all available buddies
-  active   List active buddies in the current session
-  help     Print this message or the help of the given subcommand(s)
+  with         Add buddies to the current session
+  without      Remove buddies from the current session
+  alone        Remove all buddies from the current session
+  create       Create a new buddy
+  forget       Delete a buddy from the list of available buddies
+  info         List both active and available buddies
+  list         List all available buddies
+  active       List active buddies in the current session
+  completions  Generate completions for your shell
+  help         Print this message or the help of the given subcommand(s)
 
 Options:
       --buddies-file <BUDDIES_FILE>  Use a custom buddy file instead of ~/.config/git-squad/buddies.yaml

README.md

@@ -9,8 +9,12 @@ pub struct Buddy {
 }
 
 impl Buddy {
+    pub fn format_buddy(&self) -> String {
+        format!("{} <{}>", self.name, self.email)
+    }
+
     pub fn format_co_author(&self) -> String {
-        format!("Co-authored-by: {} <{}>", self.name, self.email)
+        format!("Co-authored-by: {}", self.format_buddy())
     }
 }
 

src/buddy.rs

@@ -1,7 +1,13 @@
 use std::{io, path::PathBuf};
 
+use clap::builder::StyledStr;
 use clap::{CommandFactory, Parser, Subcommand};
-use clap_complete::{Generator, Shell, generate};
+use clap_complete::engine::{ArgValueCompleter, CompletionCandidate};
+use clap_complete::env::Shells;
+use clap_complete::{CompleteEnv, Shell, generate};
+
+use crate::config::ConfigService;
+use crate::config::FileConfig;
 
 #[derive(Debug, Parser)]
 #[command(name = "git-squad")]
@@ -16,23 +22,41 @@ pub struct Cli {
 }
 
 impl Cli {
+    pub fn new() -> Self {
+        CompleteEnv::with_factory(Cli::command).complete();
+        Self::parse()
+    }
+
     pub fn get_command(&self) -> Command {
         self.command.clone().unwrap_or(Command::Info)
     }
 }
 
-pub fn print_completions<G: Generator>(generator: G) {
-    let mut cmd = Cli::command();
-    let name = cmd.get_name().to_string();
-    generate(generator, &mut cmd, name, &mut io::stdout());
+pub fn print_completions(shell: Shell) -> anyhow::Result<()> {
+    print_completions_internal(shell, &mut Cli::command())
+}
+
+fn print_completions_internal(shell: Shell, cmd: &mut clap::Command) -> anyhow::Result<()> {
+    generate(shell, cmd, cmd.get_name().to_string(), &mut io::stdout());
+
+    println!();
+
+    let name = cmd.get_name();
+    if let Some(completer) = Shells::builtins().completer(shell.to_string().as_str()) {
+        completer.write_registration("COMPLETE", name, name, name, &mut io::stdout())?;
+    }
+
+    Ok(())
 }
 
 #[derive(Debug, Subcommand, Clone)]
 pub enum Command {
     /// Add buddies to the current session
     With {
         /// The aliases of the buddies to add
-        #[arg( required = true, num_args = 1..,)]
+        #[arg( required = true,
+               num_args = 1..,
+               add = ArgValueCompleter::new(alias_completer))]
         // TODO: I would rather  use NonEmpty<String> here but clap makes
         // this really cumbersome
         aliases: Vec<String>,
@@ -41,7 +65,9 @@ pub enum Command {
     /// Remove buddies from the current session
     Without {
         /// The aliases of the buddies to remove
-        #[arg( required = true, num_args = 1..,)]
+        #[arg( required = true,
+               num_args = 1..,
+               add = ArgValueCompleter::new(alias_completer))]
         // TODO: I would rather  use NonEmpty<String> here but clap makes
         // this really cumbersome
         aliases: Vec<String>,
@@ -59,6 +85,7 @@ pub enum Command {
     /// Delete a buddy from the list of available buddies
     Forget {
         /// The alias for the buddy to delete
+        #[arg(add = ArgValueCompleter::new(alias_completer))]
         alias: String,
     },
 
@@ -75,6 +102,24 @@ pub enum Command {
     Completions { shell: Shell },
 }
 
-pub fn parse() -> Cli {
-    Cli::parse()
+fn alias_completer(current: &std::ffi::OsStr) -> Vec<CompletionCandidate> {
+    // TODO: support completions with custom buddies_file locations
+    let conf = FileConfig { buddies_file: None };
+
+    if let Ok(buddies) = conf.load_buddies() {
+        let current = current.to_str().unwrap_or_default();
+        return buddies
+            .buddies
+            .iter()
+            .filter(|s| {
+                s.alias.starts_with(current) || s.name.starts_with(current) || s.email.starts_with(current)
+            })
+            .map(|b| {
+                let help = Some(StyledStr::from(b.format_buddy()));
+                CompletionCandidate::new(b.alias.clone()).help(help)
+            })
+            .collect();
+    }
+
+    return vec![];
 }

src/cli.rs

@@ -5,12 +5,12 @@ mod git;
 
 use anyhow::Result;
 use buddy::{Buddies, Buddy};
-use cli::{Cli, Command, print_completions};
+use cli::{print_completions, Cli, Command};
 use config::ConfigService;
 use std::io::{self, Write};
 
 fn main() -> Result<()> {
-    let cli = cli::parse();
+    let cli = Cli::new();
 
     match cli.get_command() {
         Command::With { aliases } => {
@@ -107,7 +107,7 @@ fn main() -> Result<()> {
 
         Command::Active => command_active(&cli)?,
 
-        Command::Completions { shell } => print_completions(shell),
+        Command::Completions { shell } => print_completions(shell)?,
     }
 
     Ok(())