mirror of
https://github.com/starship/starship.git
synced 2026-06-22 02:02:12 +07:00
refactor: update clap to v3 (#3370)
This commit is contained in:
David Knaack
+140
-276
@@ -4,297 +4,165 @@ use clap::crate_authors;
|
||||
use std::io;
|
||||
use std::time::SystemTime;
|
||||
|
||||
use clap::{App, AppSettings, Arg, Shell, SubCommand};
|
||||
use clap::{AppSettings, IntoApp, Parser, Subcommand};
|
||||
use clap_complete::{generate, Shell as CompletionShell};
|
||||
use rand::distributions::Alphanumeric;
|
||||
use rand::Rng;
|
||||
use starship::context::{Properties, Target};
|
||||
use starship::module::ALL_MODULES;
|
||||
use starship::*;
|
||||
|
||||
fn long_version() -> &'static str {
|
||||
let ver = Box::new(crate::shadow::clap_version());
|
||||
Box::leak(ver).as_str()
|
||||
}
|
||||
|
||||
#[derive(Parser, Debug)]
|
||||
#[clap(
|
||||
author=crate_authors!(),
|
||||
version=shadow::PKG_VERSION,
|
||||
long_version=long_version(),
|
||||
about="The cross-shell prompt for astronauts. ☄🌌️"
|
||||
)]
|
||||
#[clap(setting(AppSettings::SubcommandRequiredElseHelp))]
|
||||
struct Cli {
|
||||
#[clap(subcommand)]
|
||||
command: Commands,
|
||||
}
|
||||
|
||||
#[derive(Subcommand, Debug)]
|
||||
enum Commands {
|
||||
/// Create a pre-populated GitHub issue with information about your configuration
|
||||
BugReport,
|
||||
/// Generate starship shell completions for your shell to stdout
|
||||
Completions {
|
||||
#[clap(arg_enum)]
|
||||
shell: CompletionShell,
|
||||
},
|
||||
/// Edit the starship configuration
|
||||
Config {
|
||||
/// Configuration key to edit
|
||||
#[clap(requires = "value")]
|
||||
name: Option<String>,
|
||||
/// Value to place into that key
|
||||
value: Option<String>,
|
||||
},
|
||||
/// Explains the currently showing modules
|
||||
Explain(Properties),
|
||||
/// Prints the shell function used to execute starship
|
||||
Init {
|
||||
shell: String,
|
||||
#[clap(long)]
|
||||
print_full_init: bool,
|
||||
},
|
||||
/// Prints a specific prompt module
|
||||
Module {
|
||||
/// The name of the module to be printed
|
||||
#[clap(required = true, required_unless_present = "list")]
|
||||
name: Option<String>,
|
||||
/// List out all supported modules
|
||||
#[clap(short, long)]
|
||||
list: bool,
|
||||
#[clap(flatten)]
|
||||
properties: Properties,
|
||||
},
|
||||
/// Prints the computed starship configuration
|
||||
PrintConfig {
|
||||
/// Print the default instead of the computed config
|
||||
#[clap(short, long)]
|
||||
default: bool,
|
||||
/// Configuration keys to print
|
||||
name: Vec<String>,
|
||||
},
|
||||
/// Prints the full starship prompt
|
||||
Prompt {
|
||||
/// Print the right prompt (instead of the standard left prompt)
|
||||
#[clap(long)]
|
||||
right: bool,
|
||||
/// Print the continuation prompt (instead of the standard left prompt)
|
||||
#[clap(long, conflicts_with = "right")]
|
||||
continuation: bool,
|
||||
#[clap(flatten)]
|
||||
properties: Properties,
|
||||
},
|
||||
/// Generate random session key
|
||||
Session,
|
||||
/// Prints time in milliseconds
|
||||
#[clap(setting=AppSettings::Hidden)]
|
||||
Time,
|
||||
/// Prints timings of all active modules
|
||||
Timings(Properties),
|
||||
/// Toggle a given starship module
|
||||
Toggle {
|
||||
/// The name of the module to be toggled
|
||||
name: String,
|
||||
/// The key of the config to be toggled
|
||||
#[clap(default_value = "disabled")]
|
||||
value: String,
|
||||
},
|
||||
}
|
||||
|
||||
fn main() {
|
||||
// Configure the current terminal on windows to support ANSI escape sequences.
|
||||
#[cfg(windows)]
|
||||
let _ = ansi_term::enable_ansi_support();
|
||||
logger::init();
|
||||
|
||||
let status_code_arg = Arg::with_name("status_code")
|
||||
.short("s")
|
||||
.long("status")
|
||||
.value_name("STATUS_CODE")
|
||||
.help("The status code of the previously run command")
|
||||
.takes_value(true);
|
||||
let args = Cli::parse();
|
||||
log::trace!("Parsed arguments: {:#?}", args);
|
||||
|
||||
let pipestatus_arg = Arg::with_name("pipestatus")
|
||||
.long("pipestatus")
|
||||
.value_name("PIPESTATUS")
|
||||
.help("Status codes from a command pipeline")
|
||||
.long_help("Bash and Zsh supports returning codes for each process in a pipeline.")
|
||||
.multiple(true);
|
||||
|
||||
let terminal_width_arg = Arg::with_name("terminal_width")
|
||||
.short("w")
|
||||
.long("terminal-width")
|
||||
.value_name("TERMINAL_WIDTH")
|
||||
.help("The width of the current interactive terminal.")
|
||||
.takes_value(true);
|
||||
|
||||
let path_arg = Arg::with_name("path")
|
||||
.short("p")
|
||||
.long("path")
|
||||
.value_name("PATH")
|
||||
.help("The path that the prompt should render for.")
|
||||
.takes_value(true);
|
||||
|
||||
let logical_path_arg = Arg::with_name("logical_path")
|
||||
.short("P")
|
||||
.long("logical-path")
|
||||
.value_name("LOGICAL_PATH")
|
||||
.help(concat!(
|
||||
"The logical path that the prompt should render for. ",
|
||||
"This path should be a virtual/logical representation of the PATH argument."
|
||||
))
|
||||
.takes_value(true);
|
||||
|
||||
let shell_arg = Arg::with_name("shell")
|
||||
.value_name("SHELL")
|
||||
.help(
|
||||
"The name of the currently running shell\nCurrently supported options: bash, zsh, fish, powershell, ion, elvish, tcsh, nu, xonsh",
|
||||
)
|
||||
.required(true);
|
||||
|
||||
let cmd_duration_arg = Arg::with_name("cmd_duration")
|
||||
.short("d")
|
||||
.long("cmd-duration")
|
||||
.value_name("CMD_DURATION")
|
||||
.help("The execution duration of the last command, in milliseconds")
|
||||
.takes_value(true);
|
||||
|
||||
let keymap_arg = Arg::with_name("keymap")
|
||||
.short("k")
|
||||
.long("keymap")
|
||||
.value_name("KEYMAP")
|
||||
// fish/zsh only
|
||||
.help("The keymap of fish/zsh")
|
||||
.takes_value(true);
|
||||
|
||||
let jobs_arg = Arg::with_name("jobs")
|
||||
.short("j")
|
||||
.long("jobs")
|
||||
.value_name("JOBS")
|
||||
.help("The number of currently running jobs")
|
||||
.takes_value(true);
|
||||
|
||||
let init_scripts_arg = Arg::with_name("print_full_init")
|
||||
.long("print-full-init")
|
||||
.help("Print the main initialization script (as opposed to the init stub)");
|
||||
|
||||
let long_version = crate::shadow::clap_version();
|
||||
let mut app = App::new("starship")
|
||||
.about("The cross-shell prompt for astronauts. ☄🌌️")
|
||||
// pull the version number from Cargo.toml
|
||||
.version(shadow::PKG_VERSION)
|
||||
.long_version(long_version.as_str())
|
||||
// pull the authors from Cargo.toml
|
||||
.author(crate_authors!())
|
||||
.after_help("https://github.com/starship/starship")
|
||||
.setting(AppSettings::SubcommandRequiredElseHelp)
|
||||
.subcommand(
|
||||
SubCommand::with_name("init")
|
||||
.about("Prints the shell function used to execute starship")
|
||||
.arg(&shell_arg)
|
||||
.arg(&init_scripts_arg),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("prompt")
|
||||
.about("Prints the full starship prompt")
|
||||
.arg(
|
||||
Arg::with_name("right")
|
||||
.long("right")
|
||||
.help("Print the right prompt (instead of the standard left prompt)"),
|
||||
)
|
||||
.arg(
|
||||
Arg::with_name("continuation")
|
||||
.long("continuation")
|
||||
.help("Print the continuation prompt (instead of the standard left prompt)")
|
||||
.conflicts_with("right"),
|
||||
)
|
||||
.arg(&status_code_arg)
|
||||
.arg(&pipestatus_arg)
|
||||
.arg(&terminal_width_arg)
|
||||
.arg(&path_arg)
|
||||
.arg(&logical_path_arg)
|
||||
.arg(&cmd_duration_arg)
|
||||
.arg(&keymap_arg)
|
||||
.arg(&jobs_arg),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("module")
|
||||
.about("Prints a specific prompt module")
|
||||
.arg(
|
||||
Arg::with_name("name")
|
||||
.help("The name of the module to be printed")
|
||||
.required(true)
|
||||
.required_unless("list"),
|
||||
)
|
||||
.arg(
|
||||
Arg::with_name("list")
|
||||
.short("l")
|
||||
.long("list")
|
||||
.help("List out all supported modules"),
|
||||
)
|
||||
.arg(&status_code_arg)
|
||||
.arg(&pipestatus_arg)
|
||||
.arg(&terminal_width_arg)
|
||||
.arg(&path_arg)
|
||||
.arg(&logical_path_arg)
|
||||
.arg(&cmd_duration_arg)
|
||||
.arg(&keymap_arg)
|
||||
.arg(&jobs_arg),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("config")
|
||||
.alias("configure")
|
||||
.about("Edit the starship configuration")
|
||||
.arg(
|
||||
Arg::with_name("name")
|
||||
.help("Configuration key to edit")
|
||||
.required(false)
|
||||
.requires("value"),
|
||||
)
|
||||
.arg(Arg::with_name("value").help("Value to place into that key")),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("print-config")
|
||||
.about("Prints the computed starship configuration")
|
||||
.arg(
|
||||
Arg::with_name("default")
|
||||
.short("d")
|
||||
.long("default")
|
||||
.help("Print the default instead of the computed config")
|
||||
.takes_value(false),
|
||||
)
|
||||
.arg(
|
||||
Arg::with_name("name")
|
||||
.help("Configuration keys to print")
|
||||
.multiple(true)
|
||||
.required(false),
|
||||
),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("toggle")
|
||||
.about("Toggle a given starship module")
|
||||
.arg(
|
||||
Arg::with_name("name")
|
||||
.help("The name of the module to be toggled")
|
||||
.required(true),
|
||||
)
|
||||
.arg(
|
||||
Arg::with_name("key")
|
||||
.help("The key of the config to be toggled")
|
||||
.required(false)
|
||||
.required_unless("name"),
|
||||
),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("bug-report").about(
|
||||
"Create a pre-populated GitHub issue with information about your configuration",
|
||||
),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("time")
|
||||
.about("Prints time in milliseconds")
|
||||
.settings(&[AppSettings::Hidden]),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("explain")
|
||||
.about("Explains the currently showing modules")
|
||||
.arg(&status_code_arg)
|
||||
.arg(&pipestatus_arg)
|
||||
.arg(&terminal_width_arg)
|
||||
.arg(&path_arg)
|
||||
.arg(&logical_path_arg)
|
||||
.arg(&cmd_duration_arg)
|
||||
.arg(&keymap_arg)
|
||||
.arg(&jobs_arg),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("timings")
|
||||
.about("Prints timings of all active modules")
|
||||
.arg(&status_code_arg)
|
||||
.arg(&pipestatus_arg)
|
||||
.arg(&terminal_width_arg)
|
||||
.arg(&path_arg)
|
||||
.arg(&logical_path_arg)
|
||||
.arg(&cmd_duration_arg)
|
||||
.arg(&keymap_arg)
|
||||
.arg(&jobs_arg),
|
||||
)
|
||||
.subcommand(
|
||||
SubCommand::with_name("completions")
|
||||
.about("Generate starship shell completions for your shell to stdout")
|
||||
.arg(
|
||||
Arg::with_name("shell")
|
||||
.takes_value(true)
|
||||
.possible_values(&Shell::variants())
|
||||
.help("the shell to generate completions for")
|
||||
.value_name("SHELL")
|
||||
.required(true)
|
||||
.env("STARSHIP_SHELL"),
|
||||
),
|
||||
)
|
||||
.subcommand(SubCommand::with_name("session").about("Generate random session key"));
|
||||
|
||||
let matches = app.clone().get_matches();
|
||||
|
||||
match matches.subcommand() {
|
||||
("init", Some(sub_m)) => {
|
||||
let shell_name = sub_m.value_of("shell").expect("Shell name missing.");
|
||||
if sub_m.is_present("print_full_init") {
|
||||
init::init_main(shell_name).expect("can't init_main");
|
||||
match args.command {
|
||||
Commands::Init {
|
||||
shell,
|
||||
print_full_init,
|
||||
} => {
|
||||
if print_full_init {
|
||||
init::init_main(&shell).expect("can't init_main");
|
||||
} else {
|
||||
init::init_stub(shell_name).expect("can't init_stub");
|
||||
init::init_stub(&shell).expect("can't init_stub");
|
||||
}
|
||||
}
|
||||
("prompt", Some(sub_m)) => print::prompt(sub_m.clone()),
|
||||
("module", Some(sub_m)) => {
|
||||
if sub_m.is_present("list") {
|
||||
Commands::Prompt {
|
||||
properties,
|
||||
right,
|
||||
continuation,
|
||||
} => {
|
||||
let target = match (right, continuation) {
|
||||
(true, _) => Target::Right,
|
||||
(_, true) => Target::Continuation,
|
||||
(_, _) => Target::Main,
|
||||
};
|
||||
print::prompt(properties, target)
|
||||
}
|
||||
Commands::Module {
|
||||
name,
|
||||
list,
|
||||
properties,
|
||||
} => {
|
||||
if list {
|
||||
println!("Supported modules list");
|
||||
println!("----------------------");
|
||||
for modules in ALL_MODULES {
|
||||
println!("{}", modules);
|
||||
}
|
||||
}
|
||||
if let Some(module_name) = sub_m.value_of("name") {
|
||||
print::module(module_name, sub_m.clone());
|
||||
if let Some(module_name) = name {
|
||||
print::module(&module_name, properties);
|
||||
}
|
||||
}
|
||||
("config", Some(sub_m)) => {
|
||||
if let Some(name) = sub_m.value_of("name") {
|
||||
if let Some(value) = sub_m.value_of("value") {
|
||||
configure::update_configuration(name, value)
|
||||
Commands::Config { name, value } => {
|
||||
if let Some(name) = name {
|
||||
if let Some(value) = value {
|
||||
configure::update_configuration(&name, &value)
|
||||
}
|
||||
} else {
|
||||
configure::edit_configuration()
|
||||
}
|
||||
}
|
||||
("print-config", Some(sub_m)) => {
|
||||
let print_default = sub_m.is_present("default");
|
||||
let paths = sub_m
|
||||
.values_of("name")
|
||||
.map(|paths| paths.collect::<Vec<&str>>())
|
||||
.unwrap_or_default();
|
||||
configure::print_configuration(print_default, &paths)
|
||||
}
|
||||
("toggle", Some(sub_m)) => {
|
||||
if let Some(name) = sub_m.value_of("name") {
|
||||
if let Some(value) = sub_m.value_of("key") {
|
||||
configure::toggle_configuration(name, value)
|
||||
} else {
|
||||
configure::toggle_configuration(name, "disabled")
|
||||
}
|
||||
}
|
||||
}
|
||||
("bug-report", Some(_)) => bug_report::create(),
|
||||
("time", _) => {
|
||||
Commands::PrintConfig { default, name } => configure::print_configuration(default, &name),
|
||||
Commands::Toggle { name, value } => configure::toggle_configuration(&name, &value),
|
||||
Commands::BugReport => bug_report::create(),
|
||||
Commands::Time => {
|
||||
match SystemTime::now()
|
||||
.duration_since(SystemTime::UNIX_EPOCH)
|
||||
.ok()
|
||||
@@ -303,18 +171,15 @@ fn main() {
|
||||
None => println!("{}", -1),
|
||||
}
|
||||
}
|
||||
("explain", Some(sub_m)) => print::explain(sub_m.clone()),
|
||||
("timings", Some(sub_m)) => print::timings(sub_m.clone()),
|
||||
("completions", Some(sub_m)) => {
|
||||
let shell: Shell = sub_m
|
||||
.value_of("shell")
|
||||
.expect("Shell name missing.")
|
||||
.parse()
|
||||
.expect("Invalid shell");
|
||||
|
||||
app.gen_completions_to("starship", shell, &mut io::stdout().lock());
|
||||
}
|
||||
("session", _) => println!(
|
||||
Commands::Explain(props) => print::explain(props),
|
||||
Commands::Timings(props) => print::timings(props),
|
||||
Commands::Completions { shell } => generate(
|
||||
shell,
|
||||
&mut Cli::into_app(),
|
||||
"starship",
|
||||
&mut io::stdout().lock(),
|
||||
),
|
||||
Commands::Session => println!(
|
||||
"{}",
|
||||
rand::thread_rng()
|
||||
.sample_iter(&Alphanumeric)
|
||||
@@ -322,6 +187,5 @@ fn main() {
|
||||
.map(char::from)
|
||||
.collect::<String>()
|
||||
),
|
||||
(command, _) => unreachable!("Invalid subcommand: {}", command),
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user