Skip to content

Commit

Permalink
Add support for generating a bash completion script
Browse files Browse the repository at this point in the history
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 clap-rs/clap#1764).
Instead, we provide a utility program that emits the completion script
to standard output, accepting regular command line options itself.
  • Loading branch information
d-e-s-o committed May 5, 2020
1 parent b2d2179 commit b2d3a39
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]}
Expand Down
29 changes: 29 additions & 0 deletions utils/shell-complete.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Copyright (C) 2020 Daniel Mueller <[email protected]>
// 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());
}

0 comments on commit b2d3a39

Please sign in to comment.