diff --git a/apps/solidcraft-cli/src/main.rs b/apps/solidcraft-cli/src/main.rs index fbeb6500a..e122683e4 100644 --- a/apps/solidcraft-cli/src/main.rs +++ b/apps/solidcraft-cli/src/main.rs @@ -140,6 +140,12 @@ fn main() -> ExitCode { println!("solidcraft-cli {}", env!("CARGO_PKG_VERSION")); Ok(()) } + // Asked-for help is not an error: usage on stdout, exit 0. + Some("--help" | "-h" | "help") => { + use std::io::Write as _; + let _ = std::io::stdout().lock().write_all(USAGE.as_bytes()); + Ok(()) + } _ => Err(USAGE.to_string()), }; match r { diff --git a/apps/solidcraft-cli/tests/help_output.rs b/apps/solidcraft-cli/tests/help_output.rs new file mode 100644 index 000000000..2fda831e5 --- /dev/null +++ b/apps/solidcraft-cli/tests/help_output.rs @@ -0,0 +1,23 @@ +//! An explicit help request prints usage to stdout and succeeds; an unknown command still fails. + +use std::process::Command; + +#[test] +fn help_prints_usage_and_succeeds() { + for arg in ["--help", "-h", "help"] { + let output = Command::new(env!("CARGO_BIN_EXE_solidcraft-cli")).arg(arg).output().unwrap(); + assert!(output.status.success(), "{arg}: {}", String::from_utf8_lossy(&output.stderr)); + let stdout = String::from_utf8_lossy(&output.stdout); + assert!(stdout.starts_with("usage:"), "{arg}: {stdout}"); + assert!(stdout.contains("solidcraft-cli run"), "{arg}: {stdout}"); + assert!(output.stderr.is_empty(), "{arg}: {}", String::from_utf8_lossy(&output.stderr)); + } +} + +#[test] +fn unknown_command_still_fails_with_usage() { + let output = Command::new(env!("CARGO_BIN_EXE_solidcraft-cli")).arg("--not-a-command").output().unwrap(); + assert!(!output.status.success()); + assert!(output.stdout.is_empty()); + assert!(String::from_utf8_lossy(&output.stderr).starts_with("error: usage:")); +}