From 9cfb7ad261c584bb75876910843f4ddad4ddfce1 Mon Sep 17 00:00:00 2001
From: Daniel Mueller <deso@posteo.net>
Date: Tue, 31 Mar 2020 19:41:37 -0700
Subject: [PATCH] Add support for generating a bash completion script

This change adds support for generating a bash completion script. If
sourced, the shell will provide tab completions for the program's
arguments.
There are two possible approaches provided by clap for going about
generating shell completion functionality: either at build time, by
separately generating the clap parsers out-of-band, or at run time, as
an option to the main program itself. We are generally not too much in
favor of a run time approach, as it means less inspectability at
installation time and more overhead in the form of code crammed into the
main binary.
Hence, with this change we take the "build time" approach. Clap
recommends hooking the generation up in build.rs, but this seems like an
inflexible choice. For one, that is because it would mean
unconditionally generating this file or using some user-unfriendly
environment variable based approach for making the process conditional.
But there is also the fact that specifying the command for which to
generate the script should likely be configurable. That is a limitation
of the completion script that clap generates (see
https://github.com/clap-rs/clap/issues/1764).
In our version we provide a utility program that emits the completion
script to standard output, accepting regular command line options
itself. In doing so we allow for installation time generation of the
completion script or installation of the utility itself, the output of
which could be sourced on demand -- depending on the user's preference.
---
 CHANGELOG.md          |  1 +
 Cargo.toml            |  4 ++++
 var/shell-complete.rs | 41 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 46 insertions(+)
 create mode 100644 var/shell-complete.rs

diff --git a/CHANGELOG.md b/CHANGELOG.md
index bda1e1e5..54d6938d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,7 @@ Unreleased
   - Replaced `argparse` with `structopt`
   - Removed `argparse` dependency
   - Made the --verbose and --model options global
+- Added bash completion support via `shell-complete` utility program
 - Removed vendored dependencies and moved source code into repository
   root
 - Bumped `nitrokey` dependency to `0.6.0`
diff --git a/Cargo.toml b/Cargo.toml
index 4ad53eb7..7a181e70 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -36,6 +36,10 @@ exclude = ["ci/*", "rustfmt.toml"]
 [badges]
 gitlab = { repository = "d-e-s-o/nitrocli", branch = "master" }
 
+[[bin]]
+name = "shell-complete"
+path = "var/shell-complete.rs"
+
 [profile.release]
 opt-level = "z"
 lto = true
diff --git a/var/shell-complete.rs b/var/shell-complete.rs
new file mode 100644
index 00000000..4cbea768
--- /dev/null
+++ b/var/shell-complete.rs
@@ -0,0 +1,41 @@
+// Copyright (C) 2020 Daniel Mueller <deso@posteo.net>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+use std::io;
+
+use structopt::clap;
+use structopt::StructOpt as _;
+
+#[allow(unused)]
+mod nitrocli {
+  include!("../src/arg_util.rs");
+
+  // We only need a stripped down version of the `Command` macro.
+  macro_rules! Command {
+    ( $name:ident, [ $( $(#[$doc:meta])* $var:ident$(($inner:ty))? => $exec:expr, ) *] ) => {
+      #[derive(Debug, PartialEq, structopt::StructOpt)]
+      pub enum $name {
+        $(
+          $(#[$doc])*
+          $var$(($inner))?,
+        )*
+      }
+    };
+  }
+
+  include!("../src/arg_defs.rs");
+}
+
+/// Generate a bash completion script for nitrocli.
+#[derive(Debug, structopt::StructOpt)]
+pub struct Args {
+  /// The command for which to generate the bash completion script.
+  #[structopt(default_value = "nitrocli")]
+  pub command: String,
+}
+
+fn main() {
+  let args = Args::from_args();
+  let mut app = nitrocli::Args::clap();
+  app.gen_completions_to(&args.command, clap::Shell::Bash, &mut io::stdout());
+}