Merge pull request #435 from killercup/feature/shell-completions

Add shell completions command

Author: ArtRand

modkit/Cargo.toml

@@ -6,6 +6,7 @@ edition = "2021"
 [dependencies]
 anyhow = "1.0.68"
 clap = { version = "4.0.29", features = ["derive", "wrap_help"] }
+clap_complete_command = "0.6.1"
 indicatif = { version = "0.17.1", features = ["rayon"] }
 itertools = "0.12.1"
 log = "0.4.0"

modkit/src/commands.rs

@@ -137,6 +137,12 @@ pub enum Commands {
     #[clap(subcommand)]
     #[command(name = "open-chromatin", alias = "oc")]
     OpenChromatin(ochm::subcommand::OpenChromatin),
+    #[command(hide = true)]
+    GenerateShellCompletions {
+        /// The shell to generate the completions for
+        #[arg(value_enum)]
+        shell: clap_complete_command::Shell,
+    },
 }
 
 impl Commands {
@@ -161,6 +167,18 @@ impl Commands {
             Self::BedMethyl(x) => x.run(),
             Self::ModBam(x) => x.run(),
             Self::OpenChromatin(x) => x.run(),
+            Self::GenerateShellCompletions { shell } => {
+                use clap::{CommandFactory as _, Parser};
+
+                #[derive(Parser)]
+                #[command(name = "modkit")]
+                struct Cli {
+                    #[command(subcommand)]
+                    command: Commands,
+                }
+                shell.generate(&mut Cli::command(), &mut std::io::stdout());
+                Ok(())
+            }
         }
     }
 }

modkit/tests/test_shell_completions.rs

@@ -0,0 +1,18 @@
+use common::run_modkit;
+
+mod common;
+
+#[test]
+fn test_generate_bash_completions() {
+    let _out = run_modkit(&["generate-shell-completions", "bash"]).unwrap();
+}
+
+#[test]
+fn test_generate_zsh_completions() {
+    let _out = run_modkit(&["generate-shell-completions", "zsh"]).unwrap();
+}
+
+#[test]
+fn test_generate_fish_completions() {
+    let _out = run_modkit(&["generate-shell-completions", "fish"]).unwrap();
+}