use crate::common::*; use clap::{App, AppSettings, Arg, ArgGroup, ArgMatches}; pub(crate) const DEFAULT_SHELL: &str = "sh"; pub(crate) struct Config<'a> { pub(crate) subcommand: Subcommand<'a>, pub(crate) dry_run: bool, pub(crate) highlight: bool, pub(crate) overrides: BTreeMap<&'a str, &'a str>, pub(crate) quiet: bool, pub(crate) shell: &'a str, pub(crate) color: Color, pub(crate) verbosity: Verbosity, pub(crate) arguments: Vec<&'a str>, pub(crate) justfile: Option<&'a Path>, pub(crate) working_directory: Option<&'a Path>, pub(crate) invocation_directory: Result, } mod cmd { pub(crate) const DUMP: &str = "DUMP"; pub(crate) const EDIT: &str = "EDIT"; pub(crate) const EVALUATE: &str = "EVALUATE"; pub(crate) const LIST: &str = "LIST"; pub(crate) const SHOW: &str = "SHOW"; pub(crate) const SUMMARY: &str = "SUMMARY"; } mod arg { pub(crate) const ARGUMENTS: &str = "ARGUMENTS"; pub(crate) const COLOR: &str = "COLOR"; pub(crate) const DRY_RUN: &str = "DRY-RUN"; pub(crate) const HIGHLIGHT: &str = "HIGHLIGHT"; pub(crate) const NO_HIGHLIGHT: &str = "NO-HIGHLIGHT"; pub(crate) const JUSTFILE: &str = "JUSTFILE"; pub(crate) const QUIET: &str = "QUIET"; pub(crate) const SET: &str = "SET"; pub(crate) const SHELL: &str = "SHELL"; pub(crate) const VERBOSE: &str = "VERBOSE"; pub(crate) const WORKING_DIRECTORY: &str = "WORKING-DIRECTORY"; pub(crate) const COLOR_ALWAYS: &str = "always"; pub(crate) const COLOR_AUTO: &str = "auto"; pub(crate) const COLOR_NEVER: &str = "never"; pub(crate) const COLOR_VALUES: &[&str] = &[COLOR_AUTO, COLOR_ALWAYS, COLOR_NEVER]; } impl<'a> Config<'a> { pub(crate) fn app() -> App<'static, 'static> { let app = App::new(env!("CARGO_PKG_NAME")) .help_message("Print help information") .version_message("Print version information") .setting(AppSettings::ColoredHelp) .setting(AppSettings::TrailingVarArg) .arg( Arg::with_name(arg::ARGUMENTS) .multiple(true) .help("The recipe(s) to run, defaults to the first recipe in the justfile"), ) .arg( Arg::with_name(arg::COLOR) .long("color") .takes_value(true) .possible_values(arg::COLOR_VALUES) .default_value(arg::COLOR_AUTO) .help("Print colorful output"), ) .arg( Arg::with_name(arg::DRY_RUN) .long("dry-run") .help("Print what just would do without doing it") .conflicts_with(arg::QUIET), ) .arg( Arg::with_name(cmd::DUMP) .long("dump") .help("Print entire justfile"), ) .arg( Arg::with_name(cmd::EDIT) .short("e") .long("edit") .help("Open justfile with $EDITOR"), ) .arg( Arg::with_name(cmd::EVALUATE) .long("evaluate") .help("Print evaluated variables"), ) .arg( Arg::with_name(arg::HIGHLIGHT) .long("highlight") .help("Highlight echoed recipe lines in bold") .overrides_with(arg::NO_HIGHLIGHT), ) .arg( Arg::with_name(arg::NO_HIGHLIGHT) .long("no-highlight") .help("Don't highlight echoed recipe lines in bold") .overrides_with(arg::HIGHLIGHT), ) .arg( Arg::with_name(arg::JUSTFILE) .short("f") .long("justfile") .takes_value(true) .help("Use as justfile."), ) .arg( Arg::with_name(cmd::LIST) .short("l") .long("list") .help("List available recipes and their arguments"), ) .arg( Arg::with_name(arg::QUIET) .short("q") .long("quiet") .help("Suppress all output") .conflicts_with(arg::DRY_RUN), ) .arg( Arg::with_name(arg::SET) .long("set") .takes_value(true) .number_of_values(2) .value_names(&["VARIABLE", "VALUE"]) .multiple(true) .help("Set to "), ) .arg( Arg::with_name(arg::SHELL) .long("shell") .takes_value(true) .default_value(DEFAULT_SHELL) .help("Invoke to run recipes"), ) .arg( Arg::with_name(cmd::SHOW) .short("s") .long("show") .takes_value(true) .value_name("RECIPE") .help("Show information about "), ) .arg( Arg::with_name(cmd::SUMMARY) .long("summary") .help("List names of available recipes"), ) .arg( Arg::with_name(arg::VERBOSE) .short("v") .long("verbose") .multiple(true) .help("Use verbose output"), ) .arg( Arg::with_name(arg::WORKING_DIRECTORY) .short("d") .long("working-directory") .takes_value(true) .help("Use as working directory. --justfile must also be set") .requires(arg::JUSTFILE), ) .group(ArgGroup::with_name("EARLY-EXIT").args(&[ arg::ARGUMENTS, cmd::DUMP, cmd::EDIT, cmd::EVALUATE, cmd::LIST, cmd::SHOW, cmd::SUMMARY, ])); if cfg!(feature = "help4help2man") { app.version(env!("CARGO_PKG_VERSION")).about(concat!( "- Please see ", env!("CARGO_PKG_HOMEPAGE"), " for more information." )) } else { app .version(concat!("v", env!("CARGO_PKG_VERSION"))) .author(env!("CARGO_PKG_AUTHORS")) .about(concat!( env!("CARGO_PKG_DESCRIPTION"), " - ", env!("CARGO_PKG_HOMEPAGE") )) } } fn color_from_value(value: &str) -> ConfigResult { match value { arg::COLOR_AUTO => Ok(Color::auto()), arg::COLOR_ALWAYS => Ok(Color::always()), arg::COLOR_NEVER => Ok(Color::never()), _ => Err(ConfigError::Internal { message: format!("Invalid argument `{}` to --color.", value), }), } } pub(crate) fn from_matches(matches: &'a ArgMatches<'a>) -> ConfigResult> { let invocation_directory = env::current_dir().map_err(|e| format!("Error getting current directory: {}", e)); let verbosity = Verbosity::from_flag_occurrences(matches.occurrences_of(arg::VERBOSE)); let color = Self::color_from_value( matches .value_of(arg::COLOR) .expect("`--color` had no value"), )?; let set_count = matches.occurrences_of(arg::SET); let mut overrides = BTreeMap::new(); if set_count > 0 { let mut values = matches.values_of(arg::SET).unwrap(); for _ in 0..set_count { overrides.insert(values.next().unwrap(), values.next().unwrap()); } } fn is_override(arg: &&str) -> bool { arg.chars().skip(1).any(|c| c == '=') } let raw_arguments: Vec<&str> = matches .values_of(arg::ARGUMENTS) .map(Iterator::collect) .unwrap_or_default(); for argument in raw_arguments.iter().cloned().take_while(is_override) { let i = argument .char_indices() .skip(1) .find(|&(_, c)| c == '=') .unwrap() .0; let name = &argument[..i]; let value = &argument[i + 1..]; overrides.insert(name, value); } let arguments = raw_arguments .into_iter() .skip_while(is_override) .enumerate() .flat_map(|(i, argument)| { if i == 0 { if let Some(i) = argument.rfind('/') { if matches.is_present(arg::WORKING_DIRECTORY) { die!("--working-directory and a path prefixed recipe may not be used together."); } let (dir, recipe) = argument.split_at(i + 1); if let Err(error) = env::set_current_dir(dir) { die!("Error changing directory: {}", error); } if recipe.is_empty() { return None; } else { return Some(recipe); } } } Some(argument) }) .collect::>(); let subcommand = if matches.is_present(cmd::EDIT) { Subcommand::Edit } else if matches.is_present(cmd::SUMMARY) { Subcommand::Summary } else if matches.is_present(cmd::DUMP) { Subcommand::Dump } else if matches.is_present(cmd::LIST) { Subcommand::List } else if matches.is_present(cmd::EVALUATE) { Subcommand::Evaluate } else if let Some(name) = matches.value_of(cmd::SHOW) { Subcommand::Show { name } } else { Subcommand::Run }; Ok(Config { dry_run: matches.is_present(arg::DRY_RUN), highlight: !matches.is_present(arg::NO_HIGHLIGHT), quiet: matches.is_present(arg::QUIET), shell: matches.value_of(arg::SHELL).unwrap(), justfile: matches.value_of(arg::JUSTFILE).map(Path::new), working_directory: matches.value_of(arg::WORKING_DIRECTORY).map(Path::new), invocation_directory, subcommand, verbosity, color, overrides, arguments, }) } } impl<'a> Default for Config<'a> { fn default() -> Config<'static> { Config { subcommand: Subcommand::Run, dry_run: false, highlight: false, overrides: empty(), arguments: empty(), quiet: false, shell: DEFAULT_SHELL, color: default(), verbosity: Verbosity::from_flag_occurrences(0), justfile: None, working_directory: None, invocation_directory: env::current_dir() .map_err(|e| format!("Error getting current directory: {}", e)), } } } #[cfg(test)] mod tests { use super::*; use pretty_assertions::assert_eq; // This test guards against unintended changes to the argument parser. We should have // proper tests for all the flags, but this will do for now. #[test] fn help() { const EXPECTED_HELP: &str = "just v0.4.5 Casey Rodarmor 🤖 Just a command runner - https://github.com/casey/just USAGE: just [FLAGS] [OPTIONS] [--] [ARGUMENTS]... FLAGS: --dry-run Print what just would do without doing it --dump Print entire justfile -e, --edit Open justfile with $EDITOR --evaluate Print evaluated variables --highlight Highlight echoed recipe lines in bold -l, --list List available recipes and their arguments --no-highlight Don't highlight echoed recipe lines in bold -q, --quiet Suppress all output --summary List names of available recipes -v, --verbose Use verbose output OPTIONS: --color Print colorful output [default: auto] [possible values: auto, always, never] -f, --justfile Use as justfile. --set Set to --shell Invoke to run recipes [default: sh] -s, --show Show information about -d, --working-directory Use as working directory. --justfile must also be set ARGS: ... The recipe(s) to run, defaults to the first recipe in the justfile"; let app = Config::app().setting(AppSettings::ColorNever); let mut buffer = Vec::new(); app.write_help(&mut buffer).unwrap(); let help = str::from_utf8(&buffer).unwrap(); assert_eq!(help, EXPECTED_HELP); } }