feat(cli): port ghostty +action CLI commands
Ports ZIG/src/cli into ghostty-cli: action detection/dispatch with per-action --help, and the actions help, version, list-actions, list-colors, list-keybinds, list-themes (plain listing plus an interactive ratatui browser mirroring Ghostty's libvaxis UI), show-config, validate-config, edit-config, crash-report (listing), ssh-cache and boo (235 embedded frames). Verified byte-for-byte against the installed Ghostty 1.3.1 for stdout, stderr and exit codes of most actions, incl. tty output in a pty at widths 20-200. Known differences: +list-colors --plain prints all 782 colors (Ghostty truncates at 617 because it never flushes), +version has placeholder build info until build_info::set is wired up. Deferred: list-fonts, show-face (need font discovery integration) and new-window (needs GTK IPC); they return NotYetAvailable for now. Test Plan: - cargo test -p ghostty-cli (86 tests) - cargo run -p ghostty-cli --example cli -- +list-keybinds --plain and diff against `ghostty +list-keybinds --plain`
This commit is contained in:
1 parent
a97ae04f1d
commit
6286e02f07
46 files changed
+7135
-6
No files matched your search
@@ -0,0 +1,176 @@
|
||||
//! `+crash-report` (ZIG/src/cli/crash_report.zig and the directory listing
|
||||
//! of ZIG/src/crash/dir.zig).
|
||||
//!
|
||||
//! Ghostty uses sentry for crash reporting; only the listing behaviour is
|
||||
//! ported.
|
||||
|
||||
use std::io::{IsTerminal, Write};
|
||||
use std::path::PathBuf;
|
||||
use std::time::{SystemTime, UNIX_EPOCH};
|
||||
|
||||
use ghostty_config::types_b::Duration;
|
||||
|
||||
use crate::error::Error;
|
||||
|
||||
pub use crate::options::NoOptions as Options;
|
||||
|
||||
/// A crash report file (Zig: `crash.Report`).
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct Report {
|
||||
pub name: String,
|
||||
/// Modification time in nanoseconds since the unix epoch.
|
||||
pub mtime: i128,
|
||||
}
|
||||
|
||||
/// The default crash directory (Zig: `crash.defaultDir`):
|
||||
/// `$XDG_STATE_HOME/ghostty/crash`.
|
||||
pub fn default_dir() -> Result<PathBuf, Error> {
|
||||
let dir = ghostty_os::xdg::state(&ghostty_os::xdg::Options {
|
||||
subdir: Some("ghostty/crash"),
|
||||
home: None,
|
||||
})
|
||||
.map_err(|e| Error::Other(e.to_string()))?;
|
||||
Ok(PathBuf::from(dir))
|
||||
}
|
||||
|
||||
/// List the crash reports (regular files) in `dir`. A directory that cannot
|
||||
/// be opened yields no reports.
|
||||
pub fn list_reports(dir: &std::path::Path) -> Result<Vec<Report>, Error> {
|
||||
let Ok(rd) = std::fs::read_dir(dir) else {
|
||||
return Ok(vec![]);
|
||||
};
|
||||
let mut reports = vec![];
|
||||
for entry in rd {
|
||||
let entry = entry?;
|
||||
if !entry.file_type()?.is_file() {
|
||||
continue;
|
||||
}
|
||||
let mtime = entry.metadata()?.modified()?;
|
||||
let mtime = match mtime.duration_since(UNIX_EPOCH) {
|
||||
Ok(d) => i128::try_from(d.as_nanos()).unwrap_or(i128::MAX),
|
||||
Err(e) => -i128::try_from(e.duration().as_nanos()).unwrap_or(i128::MAX),
|
||||
};
|
||||
reports.push(Report {
|
||||
name: entry.file_name().to_string_lossy().into_owned(),
|
||||
mtime,
|
||||
});
|
||||
}
|
||||
Ok(reports)
|
||||
}
|
||||
|
||||
/// The `crash-report` command is used to inspect and send crash reports.
|
||||
///
|
||||
/// When executed without any arguments, this will list existing crash reports.
|
||||
///
|
||||
/// This command currently only supports listing crash reports. Viewing
|
||||
/// and sending crash reports is unimplemented and will be added in the future.
|
||||
pub fn run(args: &[String]) -> Result<u8, Error> {
|
||||
let mut opts = Options;
|
||||
crate::parse_options(&mut opts, args)?;
|
||||
|
||||
let stdout = std::io::stdout();
|
||||
let is_tty = stdout.is_terminal();
|
||||
let mut out = std::io::BufWriter::new(stdout.lock());
|
||||
let result = run_inner(&default_dir()?, is_tty, now_ns(), &mut out);
|
||||
let _ = out.flush();
|
||||
result
|
||||
}
|
||||
|
||||
fn now_ns() -> i128 {
|
||||
match SystemTime::now().duration_since(UNIX_EPOCH) {
|
||||
Ok(d) => i128::try_from(d.as_nanos()).unwrap_or(i128::MAX),
|
||||
Err(_) => 0,
|
||||
}
|
||||
}
|
||||
|
||||
fn run_inner(
|
||||
crash_dir: &std::path::Path,
|
||||
is_tty: bool,
|
||||
now: i128,
|
||||
stdout: &mut dyn Write,
|
||||
) -> Result<u8, Error> {
|
||||
let mut reports = list_reports(crash_dir)?;
|
||||
|
||||
// If we have no reports, then we're done. If we have a tty then we
|
||||
// print a message, otherwise we do nothing.
|
||||
if reports.is_empty() {
|
||||
if is_tty {
|
||||
stdout.write_all("No crash reports! \u{1F47B}\n".as_bytes())?;
|
||||
}
|
||||
return Ok(0);
|
||||
}
|
||||
|
||||
// Newest first.
|
||||
reports.sort_by_key(|r| std::cmp::Reverse(r.mtime));
|
||||
|
||||
for report in &reports {
|
||||
let diff = now - report.mtime;
|
||||
let since = if diff <= 0 {
|
||||
"now".to_string()
|
||||
} else {
|
||||
let d = Duration {
|
||||
duration: u64::try_from(diff).unwrap_or(u64::MAX),
|
||||
};
|
||||
format!("{} ago", d.round(1_000_000_000))
|
||||
};
|
||||
writeln!(stdout, "{} ({since})", report.name)?;
|
||||
}
|
||||
|
||||
Ok(0)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#![allow(clippy::unwrap_used)]
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn missing_dir_lists_nothing() {
|
||||
let mut out = Vec::new();
|
||||
let rc = run_inner(
|
||||
std::path::Path::new("/nonexistent/crash"),
|
||||
true,
|
||||
0,
|
||||
&mut out,
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(0, rc);
|
||||
assert_eq!("No crash reports! \u{1F47B}\n".as_bytes(), out.as_slice());
|
||||
|
||||
let mut out = Vec::new();
|
||||
run_inner(
|
||||
std::path::Path::new("/nonexistent/crash"),
|
||||
false,
|
||||
0,
|
||||
&mut out,
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(0, out.len());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lists_newest_first() {
|
||||
let dir = std::env::temp_dir().join(format!("ghostty-cli-crash-{}", std::process::id()));
|
||||
std::fs::create_dir_all(&dir).unwrap();
|
||||
std::fs::create_dir_all(dir.join("subdir")).unwrap();
|
||||
std::fs::write(dir.join("a.ghosttycrash"), "x").unwrap();
|
||||
std::fs::write(dir.join("b.ghosttycrash"), "y").unwrap();
|
||||
let old = std::fs::File::options()
|
||||
.write(true)
|
||||
.open(dir.join("a.ghosttycrash"))
|
||||
.unwrap();
|
||||
let a_time = SystemTime::now() - std::time::Duration::from_secs(1000);
|
||||
old.set_modified(a_time).unwrap();
|
||||
drop(old);
|
||||
let a_ns = i128::try_from(a_time.duration_since(UNIX_EPOCH).unwrap().as_nanos()).unwrap();
|
||||
|
||||
let mut out = Vec::new();
|
||||
run_inner(&dir, false, a_ns + (3 * 3600 + 5) * 1_000_000_000, &mut out).unwrap();
|
||||
let s = String::from_utf8(out).unwrap();
|
||||
let lines: Vec<_> = s.lines().collect();
|
||||
assert_eq!(2, lines.len(), "{s}");
|
||||
assert!(lines[0].starts_with("b.ghosttycrash ("), "{s}");
|
||||
assert_eq!("a.ghosttycrash (3h 5s ago)", lines[1]);
|
||||
std::fs::remove_dir_all(&dir).unwrap();
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user