Add a completions subcommand group for bash, fish and zsh

Author: kpcyrd

diesel_cli/src/cli.rs

@@ -90,11 +90,18 @@ pub fn build_cli() -> App<'static, 'static> {
         )
         .setting(AppSettings::SubcommandRequiredElseHelp);
 
-    let generate_bash_completion_subcommand = SubCommand::with_name("bash-completion")
-        .about("Generate bash completion script for the diesel command.");
-
-    let generate_zsh_completion_subcommand = SubCommand::with_name("zsh-completion")
-        .about("Generate zsh completion script for the diesel command.");
+    let generate_completions_subcommand = SubCommand::with_name("completions")
+        .about("Generate shell completion scripts for the diesel command.")
+        .subcommand(SubCommand::with_name("bash").about(
+            "Generate bash completions."
+        ))
+        .subcommand(SubCommand::with_name("fish").about(
+            "Generate fish completions."
+        ))
+        .subcommand(SubCommand::with_name("zsh").about(
+            "Generate zsh completions."
+        ))
+        .setting(AppSettings::SubcommandRequiredElseHelp);
 
     let infer_schema_subcommand = SubCommand::with_name("print-schema")
         .setting(AppSettings::VersionlessSubcommands)
@@ -187,8 +194,7 @@ pub fn build_cli() -> App<'static, 'static> {
         .subcommand(migration_subcommand)
         .subcommand(setup_subcommand)
         .subcommand(database_subcommand)
-        .subcommand(generate_bash_completion_subcommand)
-        .subcommand(generate_zsh_completion_subcommand)
+        .subcommand(generate_completions_subcommand)
         .subcommand(infer_schema_subcommand)
         .setting(AppSettings::SubcommandRequiredElseHelp)
 }

diesel_cli/src/main.rs

@@ -61,8 +61,7 @@ fn main() {
         ("migration", Some(matches)) => run_migration_command(matches).unwrap_or_else(handle_error),
         ("setup", Some(matches)) => run_setup_command(matches),
         ("database", Some(matches)) => run_database_command(matches).unwrap_or_else(handle_error),
-        ("bash-completion", Some(matches)) => generate_bash_completion_command(matches),
-        ("zsh-completion", Some(matches)) => generate_zsh_completion_command(matches),
+        ("completions", Some(matches)) => generate_completions_command(matches),
         ("print-schema", Some(matches)) => run_infer_schema(matches).unwrap_or_else(handle_error),
         _ => unreachable!("The cli parser should prevent reaching here"),
     }
@@ -245,12 +244,14 @@ fn run_database_command(matches: &ArgMatches) -> Result<(), Box<Error>> {
     Ok(())
 }
 
-fn generate_bash_completion_command(_: &ArgMatches) {
-    cli::build_cli().gen_completions_to("diesel", Shell::Bash, &mut stdout());
-}
-
-fn generate_zsh_completion_command(_: &ArgMatches) {
-    cli::build_cli().gen_completions_to("diesel", Shell::Zsh, &mut stdout());
+fn generate_completions_command(matches: &ArgMatches) {
+    let shell = match matches.subcommand() {
+        ("bash", _) => Shell::Bash,
+        ("fish", _) => Shell::Fish,
+        ("zsh", _) => Shell::Zsh,
+        _ => unreachable!("The cli parser should prevent reaching here"),
+    };
+    cli::build_cli().gen_completions_to("diesel", shell, &mut stdout());
 }
 
 /// Looks for a migrations directory in the current path and all parent paths,

diesel_cli/tests/completion_generation.rs

@@ -4,7 +4,16 @@ use support::project;
 fn can_generate_bash_completion() {
     let p = project("migration_redo").build();
 
-    let result = p.command("bash-completion").run();
+    let result = p.command("completions").arg("bash").run();
+
+    assert!(result.is_success(), "Result was unsuccessful {:?}", result);
+}
+
+#[test]
+fn can_generate_fish_completion() {
+    let p = project("migration_redo").build();
+
+    let result = p.command("completions").arg("fish").run();
 
     assert!(result.is_success(), "Result was unsuccessful {:?}", result);
 }
@@ -13,7 +22,7 @@ fn can_generate_bash_completion() {
 fn can_generate_zsh_completion() {
     let p = project("migration_redo").build();
 
-    let result = p.command("zsh-completion").run();
+    let result = p.command("completions").arg("zsh").run();
 
     assert!(result.is_success(), "Result was unsuccessful {:?}", result);
 }