From 2aa530a86cef7fd73893dec240c15340a536bd8d Mon Sep 17 00:00:00 2001
From: Daniel Mueller <deso@posteo.net>
Date: Mon, 4 May 2020 22:41:42 -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 some user unfriendly environment
variable based approach to making the process conditional, but also
because 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).
Instead, we provide a utility program that emits the completion script
to standard output, accepting regular command line options itself.
---
 Cargo.toml              |  4 ++++
 utils/shell-complete.rs | 29 +++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 utils/shell-complete.rs

diff --git a/Cargo.toml b/Cargo.toml
index b6accf3..c287e54 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -18,6 +18,10 @@ description = """
 A command line tool for trading stocks on Alpaca (alpaca.markets).
 """
 
+[[bin]]
+name = "shell-complete"
+path = "utils/shell-complete.rs"
+
 [dependencies]
 apca = "0.12"
 anyhow = {version = "1.0", default-features = false, features = ["std"]}
diff --git a/utils/shell-complete.rs b/utils/shell-complete.rs
new file mode 100644
index 0000000..1f464ce
--- /dev/null
+++ b/utils/shell-complete.rs
@@ -0,0 +1,29 @@
+// Copyright (C) 2020 Daniel Mueller <deso@posteo.net>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+use std::io::stdout;
+
+use structopt::clap::Shell;
+use structopt::StructOpt;
+
+
+#[allow(unused)]
+mod apcacli {
+  include!("../src/args.rs");
+}
+
+
+/// Generate a bash completion script for apcacli.
+#[derive(Debug, StructOpt)]
+pub struct Args {
+  /// The command for which to generate the bash completion script.
+  #[structopt(default_value = "apcacli")]
+  pub command: String,
+}
+
+
+fn main() {
+  let args = Args::from_args();
+  let mut app = apcacli::Args::clap();
+  app.gen_completions_to(&args.command, Shell::Bash, &mut stdout());
+}