1#![doc(
61 html_logo_url = "https://raw.githubusercontent.com/kjanat/runner/d876a0b9716806d92e07f5d5560b022b6158ecd5/branding/icon.svg",
62 html_favicon_url = "https://raw.githubusercontent.com/kjanat/runner/d876a0b9716806d92e07f5d5560b022b6158ecd5/branding/icon.svg"
63)]
64
65pub(crate) mod chain;
66mod cli;
67mod cmd;
68mod complete;
69mod config;
70mod detect;
71mod resolver;
72mod schema;
73mod tool;
74mod types;
75
76use std::ffi::OsString;
77use std::io::IsTerminal;
78use std::path::{Path, PathBuf};
79
80use anyhow::{Result, bail};
81use clap::{CommandFactory, FromArgMatches};
82use colored::Colorize;
83
84use resolver::ResolveError;
85
86#[cfg(feature = "schema")]
89#[must_use]
90pub fn config_schema() -> schemars::Schema {
91 schemars::schema_for!(config::RunnerConfig)
92}
93
94#[must_use]
105pub fn exit_code_for_error(err: &anyhow::Error) -> i32 {
106 if err.downcast_ref::<ResolveError>().is_some() {
107 2
108 } else {
109 1
110 }
111}
112
113const REPOSITORY_URL: &str = env!("CARGO_PKG_REPOSITORY");
114const VERSION: &str = clap::crate_version!();
115
116pub fn run_from_env() -> Result<i32> {
130 let bin = bin_name_from_arg0(&std::env::args_os().next().unwrap_or_default())
131 .unwrap_or_else(|| "runner".to_string());
132 clap_complete::CompleteEnv::with_factory(move || {
133 configure_cli_command(cli::Cli::command(), true)
134 .name(bin.clone())
135 .bin_name(bin.clone())
136 })
137 .shells(complete::SHELLS)
138 .complete();
139 run_from_args(std::env::args_os())
140}
141
142pub fn run_from_args<I, T>(args: I) -> Result<i32>
154where
155 I: IntoIterator<Item = T>,
156 T: Into<OsString> + Clone,
157{
158 let cwd = std::env::current_dir()?;
159 run_in_dir(args, &cwd)
160}
161
162pub fn run_in_dir<I, T>(args: I, dir: &Path) -> Result<i32>
174where
175 I: IntoIterator<Item = T>,
176 T: Into<OsString> + Clone,
177{
178 let args: Vec<OsString> = args.into_iter().map(Into::into).collect();
179
180 if requests_version(&args) {
181 println!("{}", version_line(&args, std::io::stdout().is_terminal()));
182 return Ok(0);
183 }
184
185 let cli = match parse_cli(args) {
186 Ok(cli) => cli,
187 Err(err) => return render_clap_error(&err),
188 };
189 #[cfg(feature = "lsp")]
192 if matches!(cli.command.as_ref(), Some(cli::Command::Lsp)) {
193 return cmd::lsp::run();
194 }
195 let project_dir = resolve_project_dir(
196 configured_project_dir(
197 cli.global.project_dir.as_deref(),
198 std::env::var_os("RUNNER_DIR").as_deref(),
199 )
200 .as_deref(),
201 dir,
202 )?;
203 dispatch(cli, &project_dir)
204}
205
206fn parse_cli<I, T>(args: I) -> Result<cli::Cli, clap::Error>
207where
208 I: IntoIterator<Item = T>,
209 T: Into<OsString> + Clone,
210{
211 let args: Vec<OsString> = args.into_iter().map(Into::into).collect();
212
213 let mut command = configure_cli_command(cli::Cli::command(), std::io::stdout().is_terminal());
214 if let Some(bin_name) = args.first().and_then(bin_name_from_arg0) {
215 command = command.name(bin_name.clone()).bin_name(bin_name);
216 }
217 command = shorten_help_subcommand(command);
218
219 let matches = command.try_get_matches_from(args)?;
220 cli::Cli::from_arg_matches(&matches)
221}
222
223fn shorten_help_subcommand(mut command: clap::Command) -> clap::Command {
232 command.build();
233 if command.find_subcommand("help").is_some() {
234 command.mut_subcommand("help", |help| help.about("Print help for a subcommand"))
235 } else {
236 command
237 }
238}
239
240pub fn run_alias_from_env() -> Result<i32> {
261 let bin = bin_name_from_arg0(&std::env::args_os().next().unwrap_or_default())
262 .unwrap_or_else(|| "run".to_string());
263 clap_complete::CompleteEnv::with_factory(move || {
264 configure_cli_command(cli::RunAliasCli::command(), true)
265 .name(bin.clone())
266 .bin_name(bin.clone())
267 })
268 .shells(complete::SHELLS)
269 .complete();
270 run_alias_from_args(std::env::args_os())
271}
272
273pub fn run_alias_from_args<I, T>(args: I) -> Result<i32>
283where
284 I: IntoIterator<Item = T>,
285 T: Into<OsString> + Clone,
286{
287 let cwd = std::env::current_dir()?;
288 run_alias_in_dir(args, &cwd)
289}
290
291pub fn run_alias_in_dir<I, T>(args: I, dir: &Path) -> Result<i32>
301where
302 I: IntoIterator<Item = T>,
303 T: Into<OsString> + Clone,
304{
305 let args: Vec<OsString> = args.into_iter().map(Into::into).collect();
306
307 if requests_version(&args) {
308 println!("{}", version_line(&args, std::io::stdout().is_terminal()));
309 return Ok(0);
310 }
311
312 let cli = match parse_run_alias_cli(args.clone()) {
313 Ok(cli) => cli,
314 Err(err) => {
321 return match alias_builtin_request(&err) {
322 Some(AliasBuiltin::Help) => print_run_alias_help(&args),
323 Some(AliasBuiltin::Version) => {
324 println!("{}", version_line(&args, std::io::stdout().is_terminal()));
325 Ok(0)
326 }
327 None => render_clap_error(&err),
328 };
329 }
330 };
331
332 let project_dir = resolve_project_dir(
333 configured_project_dir(
334 cli.global.project_dir.as_deref(),
335 std::env::var_os("RUNNER_DIR").as_deref(),
336 )
337 .as_deref(),
338 dir,
339 )?;
340 dispatch_run_alias(cli, &project_dir)
341}
342
343enum AliasBuiltin {
345 Help,
346 Version,
347}
348
349fn alias_builtin_request(err: &clap::Error) -> Option<AliasBuiltin> {
359 use clap::error::{ContextKind, ContextValue, ErrorKind};
360
361 if err.kind() != ErrorKind::UnknownArgument {
362 return None;
363 }
364 match err.get(ContextKind::InvalidArg) {
365 Some(ContextValue::String(arg)) => match arg.as_str() {
366 "--help" | "-h" => Some(AliasBuiltin::Help),
367 "--version" | "-V" => Some(AliasBuiltin::Version),
368 _ => None,
369 },
370 _ => None,
371 }
372}
373
374fn print_run_alias_help(args: &[OsString]) -> Result<i32> {
382 let mut command =
383 configure_cli_command(cli::RunAliasCli::command(), std::io::stdout().is_terminal());
384 if let Some(bin_name) = args.first().and_then(bin_name_from_arg0) {
385 command = command.name(bin_name.clone()).bin_name(bin_name);
386 }
387 command.print_help()?;
388 Ok(0)
389}
390
391fn parse_run_alias_cli<I, T>(args: I) -> Result<cli::RunAliasCli, clap::Error>
392where
393 I: IntoIterator<Item = T>,
394 T: Into<OsString> + Clone,
395{
396 let args: Vec<OsString> = args.into_iter().map(Into::into).collect();
397
398 let mut command =
399 configure_cli_command(cli::RunAliasCli::command(), std::io::stdout().is_terminal());
400 if let Some(bin_name) = args.first().and_then(bin_name_from_arg0) {
401 command = command.name(bin_name.clone()).bin_name(bin_name);
402 }
403
404 let matches = command.try_get_matches_from(args)?;
405 cli::RunAliasCli::from_arg_matches(&matches)
406}
407
408fn dispatch_run_alias(cli: cli::RunAliasCli, dir: &Path) -> Result<i32> {
434 let bare = cli.task.is_none() && !cli.mode.sequential && !cli.mode.parallel;
435 let command = if bare {
436 None
437 } else {
438 Some(cli::Command::Run {
439 task: cli.task,
440 args: cli.args,
441 mode: cli.mode,
442 failure: cli.failure,
443 })
444 };
445 dispatch(
446 cli::Cli {
447 global: cli.global,
448 command,
449 },
450 dir,
451 )
452}
453
454#[must_use]
474pub fn bin_name_from_arg0(arg0: &OsString) -> Option<String> {
475 let name = Path::new(arg0)
476 .file_name()
477 .map(|segment| segment.to_string_lossy().into_owned())?;
478
479 let trimmed = strip_exe_suffix(&name);
480 (!trimmed.is_empty()).then(|| trimmed.to_string())
481}
482
483fn strip_exe_suffix(name: &str) -> &str {
490 const SUFFIX: &str = ".exe";
491 if name.len() > SUFFIX.len()
492 && name.is_char_boundary(name.len() - SUFFIX.len())
493 && name[name.len() - SUFFIX.len()..].eq_ignore_ascii_case(SUFFIX)
494 {
495 &name[..name.len() - SUFFIX.len()]
496 } else {
497 name
498 }
499}
500
501#[must_use]
514pub fn configure_cli_command(command: clap::Command, stdout_is_terminal: bool) -> clap::Command {
515 command.before_help(help_byline(stdout_is_terminal))
516}
517
518#[must_use]
537pub fn help_byline(stdout_is_terminal: bool) -> String {
538 let name = env!("RUNNER_AUTHOR_NAME");
539 let rendered = if stdout_is_terminal {
540 option_env!("RUNNER_AUTHOR_EMAIL").map_or_else(
541 || name.to_string(),
542 |mail| osc8_link(name, &format!("mailto:{mail}")),
543 )
544 } else {
545 name.to_string()
546 };
547 format!("by {rendered}")
548}
549
550#[must_use]
574pub fn requests_version(args: &[OsString]) -> bool {
575 if args.len() != 2 {
576 return false;
577 }
578
579 let flag = args[1].to_string_lossy();
580 flag == "--version" || flag == "-V"
581}
582
583fn version_line(args: &[OsString], stdout_is_terminal: bool) -> String {
584 let bin = args
585 .first()
586 .and_then(bin_name_from_arg0)
587 .unwrap_or_else(|| "runner".to_string());
588
589 if !stdout_is_terminal {
590 return format!("{bin} {VERSION}");
591 }
592
593 format!(
594 "{} {}",
595 osc8_link(&bin, REPOSITORY_URL),
596 osc8_link(VERSION, &release_url(VERSION))
597 )
598}
599
600fn release_url(version: &str) -> String {
601 format!("{REPOSITORY_URL}/releases/tag/v{version}")
602}
603
604fn osc8_link(label: &str, url: &str) -> String {
605 format!("\u{1b}]8;;{url}\u{1b}\\{label}\u{1b}]8;;\u{1b}\\")
606}
607
608fn configured_project_dir(
609 project_dir: Option<&Path>,
610 env_dir: Option<&std::ffi::OsStr>,
611) -> Option<PathBuf> {
612 project_dir
613 .map(Path::to_path_buf)
614 .or_else(|| env_dir.map(PathBuf::from))
615}
616
617pub(crate) fn expand_tilde(path: &Path) -> PathBuf {
624 expand_tilde_with(path, home_dir().as_deref())
625}
626
627fn expand_tilde_with(path: &Path, home: Option<&Path>) -> PathBuf {
628 let Some(home) = home else {
629 return path.to_path_buf();
630 };
631
632 match path.strip_prefix("~") {
633 Ok(rest) if rest.as_os_str().is_empty() => home.to_path_buf(),
635 Ok(rest) => home.join(rest),
637 Err(_) => path.to_path_buf(),
639 }
640}
641
642fn home_dir() -> Option<PathBuf> {
643 let var = if cfg!(windows) { "USERPROFILE" } else { "HOME" };
644 std::env::var_os(var)
645 .filter(|v| !v.is_empty())
646 .map(PathBuf::from)
647}
648
649fn resolve_project_dir(project_dir: Option<&Path>, cwd: &Path) -> Result<PathBuf> {
650 let project_dir = project_dir.map(expand_tilde);
651 let dir = match project_dir.as_deref() {
652 Some(path) if path.is_absolute() => path.to_path_buf(),
653 Some(path) => cwd.join(path),
654 None => cwd.to_path_buf(),
655 };
656
657 if !dir.exists() {
658 bail!("project dir does not exist: {}", dir.display());
659 }
660 if !dir.is_dir() {
661 bail!("project dir is not a directory: {}", dir.display());
662 }
663
664 Ok(dir)
665}
666
667fn render_clap_error(err: &clap::Error) -> Result<i32> {
668 let exit_code = err.exit_code();
669 err.print()?;
670 Ok(exit_code)
671}
672
673fn dispatch_install_chain(
674 ctx: &types::ProjectContext,
675 overrides: &resolver::ResolutionOverrides,
676 frozen: bool,
677 mode: cli::ChainModeFlags,
678 tasks: &[String],
679) -> Result<i32> {
680 let items = chain::parse::parse_task_list(tasks)?;
681
682 if !mode.parallel {
683 let mut all = vec![chain::ChainItem::install(frozen)];
687 all.extend(items);
688 return chain::exec::run_chain(
689 ctx,
690 overrides,
691 &chain::Chain {
692 mode: chain::ChainMode::Sequential,
693 items: all,
694 failure: overrides.failure_policy,
695 },
696 );
697 }
698
699 for task in tasks {
708 cmd::run::precheck_task(ctx, overrides, task)?;
709 }
710 let started = std::time::Instant::now();
717 let install_code = cmd::install(ctx, overrides, frozen)?;
718 cmd::emit_task_timing(overrides, "install", started.elapsed(), install_code);
719 let keep_going = matches!(overrides.failure_policy, chain::FailurePolicy::KeepGoing);
720 if install_code != 0 && !keep_going {
721 return Ok(install_code);
722 }
723 let task_code = chain::exec::run_chain(
724 ctx,
725 overrides,
726 &chain::Chain {
727 mode: chain::ChainMode::Parallel,
728 items,
729 failure: overrides.failure_policy,
730 },
731 )?;
732 Ok(if install_code != 0 {
735 install_code
736 } else {
737 task_code
738 })
739}
740
741fn dispatch_run(
742 ctx: &types::ProjectContext,
743 overrides: &resolver::ResolutionOverrides,
744 task: Option<String>,
745 args: Vec<String>,
746 mode: cli::ChainModeFlags,
747) -> Result<i32> {
748 if mode.sequential || mode.parallel {
749 let chain_mode = if mode.parallel {
750 chain::ChainMode::Parallel
751 } else {
752 chain::ChainMode::Sequential
753 };
754 let mut positionals: Vec<String> = Vec::new();
755 if let Some(t) = task {
756 positionals.push(t);
757 }
758 positionals.extend(args);
759 let items = chain::parse::parse_task_list(&positionals)?;
760 let c = chain::Chain {
761 mode: chain_mode,
762 items,
763 failure: overrides.failure_policy,
764 };
765 return chain::exec::run_chain(ctx, overrides, &c);
766 }
767 let Some(task) = task.as_deref() else {
768 bail!(
769 "task name required (drop -s/-p for single-task mode or supply at least one task name)"
770 );
771 };
772 if args.is_empty()
773 && let Some(code) = run_path_builtin_fallback(ctx, overrides, task)?
774 {
775 return Ok(code);
776 }
777 cmd::run(ctx, overrides, task, &args, None)
778}
779
780fn run_path_builtin_fallback(
798 ctx: &types::ProjectContext,
799 overrides: &resolver::ResolutionOverrides,
800 name: &str,
801) -> Result<Option<i32>> {
802 if has_task(ctx, name) {
803 return Ok(None);
804 }
805 let code = match name {
806 "install" => cmd::install(ctx, overrides, false)?,
807 "clean" => {
808 cmd::clean(ctx, false, false)?;
809 0
810 }
811 "list" | "info" => {
814 cmd::list(ctx, overrides, false, false, None)?;
815 0
816 }
817 "completions" => {
818 cmd::completions(None, None)?;
819 0
820 }
821 _ => return Ok(None),
822 };
823 Ok(Some(code))
824}
825
826fn schema_version_for_json(json: bool, requested: Option<u32>) -> Result<u32> {
831 if json {
832 schema::validate_schema_version(requested.unwrap_or(schema::SCHEMA_VERSION))
833 } else {
834 Ok(schema::SCHEMA_VERSION)
835 }
836}
837
838fn build_overrides(
844 cli: &cli::Cli,
845 loaded_config: Option<&config::LoadedConfig>,
846) -> Result<resolver::ResolutionOverrides> {
847 let (cli_keep_going, cli_kill_on_fail) = match cli.command.as_ref() {
848 Some(cli::Command::Run { failure, .. } | cli::Command::Install { failure, .. }) => {
849 (failure.keep_going, failure.kill_on_fail)
850 }
851 _ => (false, false),
852 };
853 let mut overrides = resolver::ResolutionOverrides::from_cli_and_env(
854 cli.global.pm_override.as_deref(),
855 cli.global.runner_override.as_deref(),
856 cli.global.fallback.as_deref(),
857 cli.global.on_mismatch.as_deref(),
858 resolver::DiagnosticFlags {
859 no_warnings: cli.global.no_warnings,
860 quiet: cli.global.quiet,
861 explain: cli.global.explain,
862 },
863 cli::ChainFailureFlags {
864 keep_going: cli_keep_going,
865 kill_on_fail: cli_kill_on_fail,
866 },
867 loaded_config,
868 )?;
869 apply_script_policy_flags(cli, &mut overrides);
870 Ok(overrides)
871}
872
873const fn apply_script_policy_flags(cli: &cli::Cli, overrides: &mut resolver::ResolutionOverrides) {
882 if let Some(cli::Command::Install {
883 no_scripts,
884 scripts,
885 ..
886 }) = cli.command.as_ref()
887 {
888 if *no_scripts {
889 overrides.script_policy = resolver::ScriptPolicy::Deny;
890 } else if *scripts {
891 overrides.script_policy = resolver::ScriptPolicy::Allow;
892 }
893 }
894}
895
896fn build_overrides_lenient(
901 cli: &cli::Cli,
902 loaded_config: Option<&config::LoadedConfig>,
903) -> Result<(resolver::ResolutionOverrides, Vec<types::DetectionWarning>)> {
904 let (cli_keep_going, cli_kill_on_fail) = match cli.command.as_ref() {
905 Some(cli::Command::Run { failure, .. } | cli::Command::Install { failure, .. }) => {
906 (failure.keep_going, failure.kill_on_fail)
907 }
908 _ => (false, false),
909 };
910 resolver::ResolutionOverrides::from_cli_and_env_lenient(
911 cli.global.pm_override.as_deref(),
912 cli.global.runner_override.as_deref(),
913 cli.global.fallback.as_deref(),
914 cli.global.on_mismatch.as_deref(),
915 resolver::DiagnosticFlags {
916 no_warnings: cli.global.no_warnings,
917 quiet: cli.global.quiet,
918 explain: cli.global.explain,
919 },
920 cli::ChainFailureFlags {
921 keep_going: cli_keep_going,
922 kill_on_fail: cli_kill_on_fail,
923 },
924 loaded_config,
925 )
926}
927
928fn dispatch_overrides(
934 cli: &cli::Cli,
935 loaded_config: Option<&config::LoadedConfig>,
936 ctx: &mut types::ProjectContext,
937) -> Result<resolver::ResolutionOverrides> {
938 match build_overrides(cli, loaded_config) {
939 Ok(overrides) => Ok(overrides),
940 Err(_) if matches!(cli.command, Some(cli::Command::Doctor { .. })) => {
941 let (overrides, env_warnings) = build_overrides_lenient(cli, loaded_config)?;
942 ctx.warnings.extend(env_warnings);
943 Ok(overrides)
944 }
945 Err(e) => Err(e),
946 }
947}
948
949fn dispatch(cli: cli::Cli, dir: &Path) -> Result<i32> {
950 let mut ctx = detect::detect(dir);
951 let loaded_config = match config::load(dir) {
958 Ok(loaded) => loaded,
959 Err(_) if matches!(cli.command, Some(cli::Command::Config { .. })) => None,
960 Err(e) => return Err(e),
961 };
962 if let Some(loaded) = &loaded_config {
963 ctx.warnings.extend(loaded.warnings.iter().cloned());
964 }
965 let mut overrides = dispatch_overrides(&cli, loaded_config.as_ref(), &mut ctx)?;
966 overrides.parent_warned = cmd::parent_warned_about(&ctx.root);
969
970 match cli.command {
971 None => cmd::info(&ctx, &overrides, false).map(|()| 0),
972 Some(cli::Command::Info { json }) => {
976 eprintln!(
977 "{} `runner info` is deprecated; use `runner list`",
978 "warn:".yellow().bold(),
979 );
980 if actions_rs::env::is_github_actions() {
986 eprintln!(
987 "::warning title=Deprecation::`runner info` is deprecated; use `runner list`"
988 );
989 }
990 schema_version_for_json(json, cli.global.schema_version)?;
991 cmd::list(&ctx, &overrides, false, json, None)?;
992 Ok(0)
993 }
994 Some(cli::Command::Run {
995 task, args, mode, ..
996 }) => dispatch_run(&ctx, &overrides, task, args, mode),
997 Some(cli::Command::External(args)) => {
998 if args.is_empty() {
999 cmd::info(&ctx, &overrides, false)?;
1000 Ok(0)
1001 } else {
1002 cmd::run(&ctx, &overrides, &args[0], &args[1..], None)
1003 }
1004 }
1005 Some(cli::Command::Install {
1006 frozen,
1007 tasks,
1008 mode,
1009 ..
1010 }) if !tasks.is_empty() => dispatch_install_chain(&ctx, &overrides, frozen, mode, &tasks),
1011 Some(cli::Command::Install {
1012 frozen,
1013 mode,
1014 failure,
1015 ..
1016 }) => {
1017 if mode.sequential || mode.parallel || failure.keep_going || failure.kill_on_fail {
1021 eprintln!(
1022 "{} chain flags (-s/-p/-k/-K) have no effect without post-install task names",
1023 "note:".dimmed(),
1024 );
1025 }
1026 cmd::install(&ctx, &overrides, frozen)
1027 }
1028 Some(cli::Command::Clean {
1029 yes,
1030 include_framework,
1031 }) => {
1032 cmd::clean(&ctx, yes, include_framework)?;
1033 Ok(0)
1034 }
1035 Some(cli::Command::List { raw, json, source }) => {
1036 schema_version_for_json(json, cli.global.schema_version)?;
1037 cmd::list(&ctx, &overrides, raw, json, source.as_deref())?;
1038 Ok(0)
1039 }
1040 Some(cli::Command::Completions { shell, output }) => {
1041 cmd::completions(shell, output.as_deref())?;
1042 Ok(0)
1043 }
1044 #[cfg(feature = "man")]
1045 Some(cli::Command::Man { output }) => dispatch_man(output.as_deref()),
1046 #[cfg(feature = "schema")]
1047 Some(cli::Command::Schema { all, output }) => dispatch_schema(all, output.as_deref()),
1048 #[cfg(feature = "lsp")]
1049 Some(cli::Command::Lsp) => cmd::lsp::run(), Some(cli::Command::Doctor { json }) => {
1051 schema_version_for_json(json, cli.global.schema_version)?;
1052 cmd::doctor(&ctx, &overrides, json)?;
1053 Ok(0)
1054 }
1055 Some(cli::Command::Config { action }) => cmd::config(dir, action),
1056 Some(cli::Command::Why { task, json }) => {
1057 schema_version_for_json(json, cli.global.schema_version)?;
1058 cmd::why(&ctx, &overrides, &task, json)?;
1059 Ok(0)
1060 }
1061 }
1062}
1063
1064#[cfg(feature = "man")]
1065fn dispatch_man(output: Option<&Path>) -> Result<i32> {
1066 match output {
1067 Some(dir) => cmd::write_man_pages(dir)?,
1068 None => cmd::write_runner_page_to_stdout()?,
1069 }
1070 Ok(0)
1071}
1072
1073#[cfg(feature = "schema")]
1074fn dispatch_schema(all: bool, output: Option<&Path>) -> Result<i32> {
1075 cmd::write_schema(all, output)?;
1076 Ok(0)
1077}
1078
1079fn has_task(ctx: &types::ProjectContext, name: &str) -> bool {
1081 ctx.tasks.iter().any(|task| task.name == name)
1082}
1083
1084#[cfg(test)]
1085mod tests {
1086 use std::ffi::OsString;
1087 use std::fs;
1088 use std::path::{Path, PathBuf};
1089
1090 use super::{
1091 AliasBuiltin, VERSION, alias_builtin_request, bin_name_from_arg0, configured_project_dir,
1092 exit_code_for_error, expand_tilde_with, has_task, parse_cli, parse_run_alias_cli,
1093 release_url, requests_version, resolve_project_dir, run_alias_in_dir, run_in_dir,
1094 version_line,
1095 };
1096 use crate::cli;
1097 use crate::resolver::ResolveError;
1098 use crate::tool::test_support::TempDir;
1099 use crate::types::{Ecosystem, ProjectContext, Task, TaskSource};
1100
1101 #[test]
1102 fn exit_code_for_resolve_error_is_two() {
1103 let err: anyhow::Error = ResolveError::NoSignalsFound {
1104 ecosystem: Ecosystem::Node,
1105 soft: false,
1106 }
1107 .into();
1108
1109 assert_eq!(exit_code_for_error(&err), 2);
1110 }
1111
1112 #[test]
1113 fn exit_code_for_generic_error_is_one() {
1114 let err = anyhow::anyhow!("generic boom");
1115
1116 assert_eq!(exit_code_for_error(&err), 1);
1117 }
1118
1119 #[test]
1120 fn help_returns_zero_instead_of_exiting() {
1121 let code = run_in_dir(["runner", "--help"], Path::new("."))
1122 .expect("help should return an exit code");
1123
1124 assert_eq!(code, 0);
1125 }
1126
1127 #[test]
1128 fn invalid_args_return_non_zero_instead_of_exiting() {
1129 let code = run_in_dir(["runner", "--definitely-invalid"], Path::new("."))
1130 .expect("parse errors should return an exit code");
1131
1132 assert_ne!(code, 0);
1133 }
1134
1135 #[test]
1136 fn version_returns_zero_instead_of_exiting() {
1137 let code = run_in_dir(["runner", "--version"], Path::new("."))
1138 .expect("version should return an exit code");
1139
1140 assert_eq!(code, 0);
1141 }
1142
1143 #[test]
1144 fn requests_version_detects_top_level_version_flags() {
1145 assert!(requests_version(&[
1146 OsString::from("runner"),
1147 OsString::from("--version")
1148 ]));
1149 assert!(requests_version(&[
1150 OsString::from("runner"),
1151 OsString::from("-V")
1152 ]));
1153 assert!(!requests_version(&[
1154 OsString::from("runner"),
1155 OsString::from("info"),
1156 OsString::from("--version"),
1157 ]));
1158 }
1159
1160 #[test]
1161 fn release_url_points_to_version_tag() {
1162 assert_eq!(
1163 release_url(VERSION),
1164 format!("https://github.com/kjanat/runner/releases/tag/v{VERSION}")
1165 );
1166 }
1167
1168 #[test]
1169 fn version_line_wraps_bin_and_version_with_separate_links() {
1170 let line = version_line(&[OsString::from("runner")], true);
1171
1172 assert!(line.contains(
1173 "\u{1b}]8;;https://github.com/kjanat/runner\u{1b}\\runner\u{1b}]8;;\u{1b}\\"
1174 ));
1175 assert!(line.contains(&format!(
1176 "\u{1b}]8;;https://github.com/kjanat/runner/releases/tag/v{VERSION}\u{1b}\\{VERSION}\u{1b}]8;;\u{1b}\\"
1177 )));
1178 }
1179
1180 #[test]
1181 fn resolve_project_dir_uses_cwd_when_not_overridden() {
1182 let cwd = TempDir::new("runner-project-dir-default");
1183
1184 assert_eq!(
1185 resolve_project_dir(None, cwd.path()).expect("cwd should be accepted"),
1186 cwd.path()
1187 );
1188 }
1189
1190 #[test]
1191 fn resolve_project_dir_resolves_relative_paths_from_cwd() {
1192 let cwd = TempDir::new("runner-project-dir-cwd");
1193 fs::create_dir(cwd.path().join("child")).expect("child dir should be created");
1194
1195 let resolved = resolve_project_dir(Some(Path::new("child")), cwd.path())
1196 .expect("relative dir should resolve");
1197
1198 assert_eq!(resolved, cwd.path().join("child"));
1199 }
1200
1201 #[test]
1202 fn resolve_project_dir_rejects_missing_directories() {
1203 let cwd = TempDir::new("runner-project-dir-missing");
1204 let err = resolve_project_dir(Some(Path::new("missing")), cwd.path())
1205 .expect_err("missing dir should error");
1206
1207 assert!(err.to_string().contains("project dir does not exist"));
1208 }
1209
1210 #[test]
1211 fn expand_tilde_expands_leading_tilde_slash() {
1212 let home = Path::new("/home/example");
1213 assert_eq!(
1214 expand_tilde_with(Path::new("~/projects/recipe"), Some(home)),
1215 home.join("projects/recipe"),
1216 );
1217 }
1218
1219 #[test]
1220 fn expand_tilde_expands_bare_tilde() {
1221 let home = Path::new("/home/example");
1222 assert_eq!(expand_tilde_with(Path::new("~"), Some(home)), home);
1223 }
1224
1225 #[test]
1226 fn expand_tilde_leaves_other_paths_untouched() {
1227 let home = Path::new("/home/example");
1228 for raw in ["/abs/path", "relative/path", "~user/projects", "./~/foo"] {
1229 assert_eq!(
1230 expand_tilde_with(Path::new(raw), Some(home)),
1231 PathBuf::from(raw),
1232 "path {raw} should be unchanged",
1233 );
1234 }
1235 }
1236
1237 #[test]
1238 fn expand_tilde_without_home_is_noop() {
1239 assert_eq!(
1240 expand_tilde_with(Path::new("~/projects"), None),
1241 PathBuf::from("~/projects"),
1242 );
1243 }
1244
1245 #[test]
1246 fn resolve_project_dir_does_not_join_tilde_onto_cwd() {
1247 let home_var = if cfg!(windows) { "USERPROFILE" } else { "HOME" };
1253 if std::env::var_os(home_var).is_none_or(|v| v.is_empty()) {
1254 return;
1257 }
1258
1259 let cwd = TempDir::new("runner-project-dir-tilde");
1260 let err = resolve_project_dir(Some(Path::new("~/definitely-missing")), cwd.path())
1261 .expect_err("tilde dir should not resolve against cwd");
1262
1263 let message = err.to_string();
1264 assert!(message.contains("project dir does not exist"));
1265 let joined_tilde = cwd.path().join("~");
1268 assert!(
1269 !message.contains(&joined_tilde.display().to_string()),
1270 "tilde must not be joined onto cwd: {message}",
1271 );
1272 }
1273
1274 #[test]
1275 fn configured_project_dir_prefers_flag_over_env() {
1276 let dir = configured_project_dir(
1277 Some(Path::new("flag-dir")),
1278 Some(std::ffi::OsStr::new("env-dir")),
1279 )
1280 .expect("dir should be selected");
1281
1282 assert_eq!(dir, PathBuf::from("flag-dir"));
1283 }
1284
1285 #[test]
1286 fn configured_project_dir_falls_back_to_env() {
1287 let dir = configured_project_dir(None, Some(std::ffi::OsStr::new("env-dir")))
1288 .expect("env dir should be selected");
1289
1290 assert_eq!(dir, PathBuf::from("env-dir"));
1291 }
1292
1293 #[test]
1294 fn bin_name_from_arg0_uses_path_file_name() {
1295 let name = bin_name_from_arg0(&OsString::from("/tmp/run"));
1296
1297 assert_eq!(name.as_deref(), Some("run"));
1298 }
1299
1300 #[test]
1301 fn bin_name_from_arg0_strips_windows_exe_suffix() {
1302 let runner = bin_name_from_arg0(&OsString::from("runner.exe"));
1308 assert_eq!(runner.as_deref(), Some("runner"));
1309
1310 let run = bin_name_from_arg0(&OsString::from("run.exe"));
1311 assert_eq!(run.as_deref(), Some("run"));
1312 }
1313
1314 #[test]
1315 fn bin_name_from_arg0_strips_exe_case_insensitive() {
1316 let upper = bin_name_from_arg0(&OsString::from("RUNNER.EXE"));
1317 assert_eq!(upper.as_deref(), Some("RUNNER"));
1318
1319 let mixed = bin_name_from_arg0(&OsString::from("Run.Exe"));
1320 assert_eq!(mixed.as_deref(), Some("Run"));
1321 }
1322
1323 #[test]
1324 fn bin_name_from_arg0_preserves_unrelated_extensions() {
1325 let dotted = bin_name_from_arg0(&OsString::from("/tmp/runner.exe.bak"));
1328 assert_eq!(dotted.as_deref(), Some("runner.exe.bak"));
1329
1330 let other = bin_name_from_arg0(&OsString::from("/tmp/runner.sh"));
1331 assert_eq!(other.as_deref(), Some("runner.sh"));
1332 }
1333
1334 #[test]
1335 fn bin_name_from_arg0_handles_bare_dot_exe() {
1336 let bare = bin_name_from_arg0(&OsString::from(".exe"));
1339 assert_eq!(bare.as_deref(), Some(".exe"));
1340 }
1341
1342 fn stub_context(tasks: &[&str]) -> ProjectContext {
1343 ProjectContext {
1344 root: PathBuf::from("."),
1345 package_managers: Vec::new(),
1346 task_runners: Vec::new(),
1347 tasks: tasks
1348 .iter()
1349 .map(|name| Task {
1350 name: (*name).to_string(),
1351 source: TaskSource::PackageJson,
1352 run_target: None,
1353 description: None,
1354 alias_of: None,
1355 passthrough_to: None,
1356 })
1357 .collect(),
1358 node_version: None,
1359 current_node: None,
1360 is_monorepo: false,
1361 install_dirs: Vec::new(),
1362 warnings: Vec::new(),
1363 }
1364 }
1365
1366 #[test]
1367 fn has_task_returns_true_for_existing_task() {
1368 let ctx = stub_context(&["clean", "install"]);
1369
1370 assert!(has_task(&ctx, "clean"));
1371 assert!(has_task(&ctx, "install"));
1372 assert!(!has_task(&ctx, "build"));
1373 }
1374
1375 #[test]
1376 fn run_alias_parses_builtin_names_as_tasks() {
1377 for name in [
1378 "clean",
1379 "install",
1380 "list",
1381 "exec",
1382 "info",
1383 "completions",
1384 "run",
1385 ] {
1386 let cli = parse_run_alias_cli(["run", name])
1387 .unwrap_or_else(|e| panic!("run {name} should parse: {e}"));
1388
1389 assert_eq!(cli.task.as_deref(), Some(name));
1390 assert!(cli.args.is_empty());
1391 }
1392 }
1393
1394 #[test]
1395 fn run_alias_forwards_trailing_args() {
1396 let cli = parse_run_alias_cli(["run", "test", "--watch", "--reporter=verbose"])
1397 .expect("run test --watch --reporter=verbose should parse");
1398
1399 assert_eq!(cli.task.as_deref(), Some("test"));
1400 assert_eq!(cli.args, vec!["--watch", "--reporter=verbose"]);
1401 }
1402
1403 #[test]
1404 fn run_alias_bare_has_no_task() {
1405 let cli = parse_run_alias_cli(["run"]).expect("bare run should parse");
1406
1407 assert!(cli.task.is_none());
1408 assert!(cli.args.is_empty());
1409 }
1410
1411 #[test]
1412 fn run_alias_honours_dir_flag() {
1413 let cli = parse_run_alias_cli(["run", "--dir=other", "build"])
1414 .expect("run --dir=other build should parse");
1415
1416 assert_eq!(cli.global.project_dir, Some(PathBuf::from("other")));
1417 assert_eq!(cli.task.as_deref(), Some("build"));
1418 }
1419
1420 #[test]
1421 fn run_alias_bare_shows_info() {
1422 let dir = TempDir::new("runner-run-bare");
1423
1424 let code =
1425 run_alias_in_dir(["run"], dir.path()).expect("bare run should succeed on empty dir");
1426
1427 assert_eq!(code, 0);
1428 }
1429
1430 #[test]
1431 fn run_alias_dispatch_shares_override_building_with_runner() {
1432 let dir = TempDir::new("runner-run-alias-bad-pm");
1437 let err = run_alias_in_dir(["run", "--pm", "zoot", "build"], dir.path())
1438 .expect_err("unknown --pm should error through the shared dispatch path");
1439 assert!(
1440 format!("{err}").contains("unknown package manager"),
1441 "alias must reuse the runner override builder: {err}",
1442 );
1443 }
1444
1445 #[test]
1446 fn run_alias_bare_matches_bare_runner_dashboard() {
1447 let dir = TempDir::new("runner-run-alias-bare-eq");
1451 let alias = run_alias_in_dir(["run"], dir.path()).expect("bare run should succeed");
1452 let runner = run_in_dir(["runner"], dir.path()).expect("bare runner should succeed");
1453 assert_eq!(alias, runner, "alias bare dispatch must match bare runner");
1454 assert_eq!(alias, 0);
1455 }
1456
1457 #[test]
1458 fn run_alias_bare_drops_chain_failure_flag() {
1459 let dir = TempDir::new("runner-run-alias-bare-drop-flag");
1468 fs::write(
1469 dir.path().join(crate::config::CONFIG_FILENAME),
1470 "[chain]\nkill_on_fail = true\n",
1471 )
1472 .expect("write runner.toml");
1473
1474 let code = run_alias_in_dir(["run", "-k"], dir.path())
1475 .expect("bare `run -k` must not error on an opposite-polarity [chain] config");
1476 assert_eq!(code, 0, "bare dashboard ignores the dropped failure flag");
1477 }
1478
1479 #[test]
1480 fn run_alias_forwards_help_and_version_after_task() {
1481 for flag in ["--help", "-h", "--version", "-V"] {
1485 let cli = parse_run_alias_cli(["run", "build", flag])
1486 .unwrap_or_else(|e| panic!("run build {flag} should parse: {e}"));
1487 assert_eq!(cli.task.as_deref(), Some("build"));
1488 assert_eq!(cli.args, vec![flag.to_string()]);
1489 }
1490 }
1491
1492 #[test]
1493 fn run_alias_forwards_interleaved_help_flag() {
1494 let cli = parse_run_alias_cli(["run", "build", "--foo", "--help", "--bar"])
1496 .expect("interleaved --help should parse and forward");
1497 assert_eq!(cli.task.as_deref(), Some("build"));
1498 assert_eq!(cli.args, vec!["--foo", "--help", "--bar"]);
1499 }
1500
1501 #[test]
1502 fn run_alias_double_dash_forwards_help_literally() {
1503 let cli = parse_run_alias_cli(["run", "build", "--", "--help"])
1506 .expect("run build -- --help should parse");
1507 assert_eq!(cli.task.as_deref(), Some("build"));
1508 assert_eq!(cli.args, vec!["--help"]);
1509 }
1510
1511 #[test]
1512 fn run_alias_leading_builtins_classified_as_own_request() {
1513 for flag in ["--help", "-h"] {
1517 let err = parse_run_alias_cli(["run", flag])
1518 .expect_err("leading help flag should not parse as a task");
1519 assert!(
1520 matches!(alias_builtin_request(&err), Some(AliasBuiltin::Help)),
1521 "{flag} before a task should be classified as a help request",
1522 );
1523 }
1524 for flag in ["--version", "-V"] {
1525 let err = parse_run_alias_cli(["run", flag])
1526 .expect_err("leading version flag should not parse as a task");
1527 assert!(
1528 matches!(alias_builtin_request(&err), Some(AliasBuiltin::Version)),
1529 "{flag} before a task should be classified as a version request",
1530 );
1531 }
1532 }
1533
1534 #[test]
1535 fn run_alias_global_flag_before_help_still_classified_as_help() {
1536 let err = parse_run_alias_cli(["run", "--pm", "npm", "--help"])
1539 .expect_err("--pm npm --help should not parse as a task");
1540 assert!(matches!(
1541 alias_builtin_request(&err),
1542 Some(AliasBuiltin::Help)
1543 ));
1544 }
1545
1546 #[test]
1547 fn run_alias_unknown_flag_is_not_a_builtin_request() {
1548 let err = parse_run_alias_cli(["run", "--bogus"])
1551 .expect_err("unknown leading flag should not parse");
1552 assert!(alias_builtin_request(&err).is_none());
1553 }
1554
1555 #[test]
1556 fn run_alias_own_help_and_version_return_zero() {
1557 let dir = TempDir::new("runner-run-builtin");
1562 assert_eq!(
1563 run_alias_in_dir(["run", "--help"], dir.path()).expect("run --help should succeed"),
1564 0,
1565 );
1566 assert_eq!(
1567 run_alias_in_dir(["run", "--pm", "npm", "--version"], dir.path())
1568 .expect("run --pm npm --version should succeed"),
1569 0,
1570 );
1571 }
1572
1573 #[test]
1574 fn runner_cli_still_parses_install_as_builtin_when_flag_set() {
1575 let cli = parse_cli(["runner", "install", "--frozen"]).expect("should parse");
1576
1577 match cli.command {
1578 Some(cli::Command::Install { frozen: true, .. }) => {}
1579 other => panic!("expected Install {{ frozen: true }}, got {other:?}"),
1580 }
1581 }
1582
1583 #[test]
1584 fn runner_cli_parses_install_frozen_short_flag() {
1585 let cli = parse_cli(["runner", "install", "-f"]).expect("should parse");
1586
1587 match cli.command {
1588 Some(cli::Command::Install { frozen: true, .. }) => {}
1589 other => panic!("expected Install {{ frozen: true }}, got {other:?}"),
1590 }
1591 }
1592
1593 #[test]
1594 fn runner_cli_parses_install_chain_flags_after_task_names() {
1595 let cli = parse_cli(["runner", "install", "build", "test", "-K"]).expect("parses");
1599 match cli.command {
1600 Some(cli::Command::Install {
1601 tasks,
1602 failure:
1603 cli::ChainFailureFlags {
1604 kill_on_fail: true, ..
1605 },
1606 ..
1607 }) => assert_eq!(tasks, vec!["build".to_string(), "test".to_string()]),
1608 other => {
1609 panic!("expected Install with kill_on_fail=true and clean task list, got {other:?}")
1610 }
1611 }
1612 }
1613
1614 #[test]
1615 fn runner_cli_parses_clean_as_builtin_when_flag_set() {
1616 let cli = parse_cli(["runner", "clean", "-y"]).expect("should parse");
1617
1618 match cli.command {
1619 Some(cli::Command::Clean { yes: true, .. }) => {}
1620 other => panic!("expected Clean {{ yes: true, .. }}, got {other:?}"),
1621 }
1622 }
1623
1624 #[test]
1625 fn runner_cli_routes_unknown_name_to_external() {
1626 let cli = parse_cli(["runner", "no-such-builtin"]).expect("should parse");
1627
1628 match cli.command {
1629 Some(cli::Command::External(args)) => {
1630 assert_eq!(args, vec!["no-such-builtin"]);
1631 }
1632 other => panic!("expected External, got {other:?}"),
1633 }
1634 }
1635
1636 #[test]
1637 fn runner_cli_parses_pm_and_runner_overrides_globally() {
1638 let cli = parse_cli(["runner", "--pm", "pnpm", "--runner", "just", "run", "build"])
1639 .expect("global --pm/--runner should parse on the run subcommand");
1640
1641 assert_eq!(cli.global.pm_override.as_deref(), Some("pnpm"));
1642 assert_eq!(cli.global.runner_override.as_deref(), Some("just"));
1643 match cli.command {
1644 Some(cli::Command::Run { task, args, .. }) => {
1645 assert_eq!(task.as_deref(), Some("build"));
1646 assert!(args.is_empty());
1647 }
1648 other => panic!("expected Run, got {other:?}"),
1649 }
1650 }
1651
1652 #[test]
1653 fn run_alias_parses_pm_override() {
1654 let cli =
1655 parse_run_alias_cli(["run", "--pm=bun", "test"]).expect("--pm=bun test should parse");
1656
1657 assert_eq!(cli.global.pm_override.as_deref(), Some("bun"));
1658 assert_eq!(cli.task.as_deref(), Some("test"));
1659 }
1660
1661 #[test]
1662 fn invalid_pm_override_value_returns_error() {
1663 let dir = TempDir::new("runner-bad-pm");
1666 let result = run_in_dir(["runner", "--pm", "zoot", "info"], dir.path());
1667
1668 let err = result.expect_err("unknown --pm should error");
1669 assert!(format!("{err}").contains("unknown package manager"));
1670 }
1671
1672 #[test]
1673 fn install_with_undetected_pm_override_exits_2() {
1674 let dir = TempDir::new("runner-install-undetected-pm");
1678 fs::write(
1679 dir.path().join("Cargo.toml"),
1680 "[package]\nname = \"fixture\"\nversion = \"0.0.0\"\n",
1681 )
1682 .expect("write Cargo.toml");
1683
1684 let err = run_in_dir(["runner", "--pm", "npm", "install"], dir.path())
1685 .expect_err("undetected --pm should refuse the install");
1686
1687 assert_eq!(
1688 exit_code_for_error(&err),
1689 2,
1690 "ResolveError must map to exit 2"
1691 );
1692 let msg = format!("{err}");
1693 assert!(msg.contains("--pm"), "should name the source: {msg}");
1694 assert!(msg.contains("cargo"), "should list detected PMs: {msg}");
1695 }
1696
1697 #[test]
1698 fn install_chain_with_undetected_pm_override_exits_2() {
1699 let dir = TempDir::new("runner-install-chain-undetected-pm");
1701 fs::write(
1702 dir.path().join("Cargo.toml"),
1703 "[package]\nname = \"fixture\"\nversion = \"0.0.0\"\n",
1704 )
1705 .expect("write Cargo.toml");
1706
1707 let err = run_in_dir(["runner", "--pm", "npm", "install", "build"], dir.path())
1708 .expect_err("undetected --pm should refuse the install chain");
1709
1710 assert_eq!(
1711 exit_code_for_error(&err),
1712 2,
1713 "ResolveError must map to exit 2"
1714 );
1715 }
1716
1717 #[test]
1718 fn schema_version_rejects_invalid_for_non_json_commands() {
1719 let dir = TempDir::new("runner-schema-invalid-completions");
1720
1721 let code = run_in_dir(
1722 ["runner", "--schema-version", "99", "completions", "bash"],
1723 dir.path(),
1724 )
1725 .expect("parse errors should return an exit code");
1726
1727 assert_ne!(code, 0);
1728 }
1729
1730 #[test]
1731 fn schema_version_rejects_invalid_for_run_alias_bare_info() {
1732 let dir = TempDir::new("runner-schema-invalid-run-alias");
1733
1734 let code = run_alias_in_dir(["run", "--schema-version", "99"], dir.path())
1735 .expect("parse errors should return an exit code");
1736
1737 assert_ne!(code, 0);
1738 }
1739
1740 #[test]
1741 fn schema_version_rejects_invalid_for_json_output() {
1742 let dir = TempDir::new("runner-schema-json-invalid");
1743
1744 let code = run_in_dir(
1745 ["runner", "--schema-version", "99", "info", "--json"],
1746 dir.path(),
1747 )
1748 .expect("parse errors should return an exit code");
1749
1750 assert_ne!(code, 0);
1751 }
1752
1753 #[test]
1754 fn runner_cli_parses_completions_output_long() {
1755 let cli = parse_cli(["runner", "completions", "--output", "/tmp/runner.zsh"])
1756 .expect("should parse");
1757
1758 match cli.command {
1759 Some(cli::Command::Completions {
1760 shell: None,
1761 output: Some(path),
1762 }) => assert_eq!(path, PathBuf::from("/tmp/runner.zsh")),
1763 other => panic!("expected Completions with --output long form, got {other:?}"),
1764 }
1765 }
1766
1767 #[test]
1768 fn runner_cli_parses_completions_output_short() {
1769 let cli =
1770 parse_cli(["runner", "completions", "-o", "/tmp/runner.zsh"]).expect("should parse");
1771
1772 match cli.command {
1773 Some(cli::Command::Completions {
1774 shell: None,
1775 output: Some(path),
1776 }) => assert_eq!(path, PathBuf::from("/tmp/runner.zsh")),
1777 other => panic!("expected Completions with -o short form, got {other:?}"),
1778 }
1779 }
1780
1781 #[test]
1782 fn runner_cli_parses_completions_shell_and_output() {
1783 let cli = parse_cli([
1784 "runner",
1785 "completions",
1786 "zsh",
1787 "--output",
1788 "/tmp/runner.zsh",
1789 ])
1790 .expect("should parse");
1791
1792 match cli.command {
1793 Some(cli::Command::Completions {
1794 shell: Some(_),
1795 output: Some(path),
1796 }) => assert_eq!(path, PathBuf::from("/tmp/runner.zsh")),
1797 other => panic!("expected Completions with both shell and output set, got {other:?}"),
1798 }
1799 }
1800}