add shell completion generation (#100)

* add shell completion generation * remove extra printline * use long form only for completion arg Co-authored-by: Trent <[email protected]> --------- Co-authored-by: Trent <[email protected]>
tbillington · Oct 17, 2023 · 69c153b · 69c153b
1 parent d3fcf9b
commit 69c153b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/kondo/Cargo.toml b/kondo/Cargo.toml
@@ -20,6 +20,7 @@ edition = "2021"
 
 [dependencies]
 clap = { version = "4", features = ["derive"] }
+clap_complete = "4"
 
 [dependencies.kondo-lib]
 path = "../kondo-lib"

diff --git a/kondo/src/main.rs b/kondo/src/main.rs
@@ -8,7 +8,8 @@ use std::{
     sync::mpsc::{Receiver, Sender, SyncSender},
 };
 
-use clap::Parser;
+use clap::{Command, CommandFactory, Parser};
+use clap_complete::{generate, Generator, Shell};
 
 use kondo_lib::{
     dir_size, path_canonicalise, pretty_size, print_elapsed, scan, Project, ScanOptions,
@@ -49,6 +50,10 @@ struct Opt {
     #[arg(short, long, value_parser = parse_age_filter, default_value = "0d")]
     older: u64,
 
+    /// Generates completions for the specified shell
+    #[arg(long = "completions", value_enum)]
+    generator: Option<Shell>,
+
     /// If there is no input, defaults to yes
     #[arg(short, long)]
     default: bool,
@@ -285,9 +290,20 @@ fn interactive_prompt(
     }
 }
 
+fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
+    generate(gen, cmd, cmd.get_name().to_string(), &mut stdout());
+}
+
 fn main() -> Result<(), Box<dyn Error>> {
     let mut opt = Opt::parse();
 
+    if let Some(generator) = opt.generator {
+        let mut cmd = Opt::command();
+        eprintln!("Generating completion file for {generator:?}...");
+        print_completions(generator, &mut cmd);
+        return Ok(());
+    }
+
     if opt.quiet > 0 && !opt.all {
         eprintln!("Quiet mode can only be used with --all.");
         std::process::exit(1);