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,239 @@
|
||||
//! `+new-window` (ZIG/src/cli/new_window.zig).
|
||||
//!
|
||||
//! DEFERRED: sending the IPC needs the GTK app (`apprt.App.performIpc`).
|
||||
//! The option parsing (including the manual `+new-window` argument gathering
|
||||
//! hook) is ported; running the action reports that it is not available.
|
||||
|
||||
use ghostty_config::cli_args::{ArgError, ArgIter, CliTarget};
|
||||
|
||||
use crate::error::Error;
|
||||
|
||||
/// Options of `+new-window`.
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct Options {
|
||||
/// If set, open up a new window in a custom instance of Ghostty.
|
||||
pub class: Option<String>,
|
||||
|
||||
/// Did the user specify a `--working-directory` argument on the command line?
|
||||
pub working_directory_seen: bool,
|
||||
|
||||
/// All of the arguments after `+new-window`. They will be sent to Ghostty
|
||||
/// for processing.
|
||||
pub arguments: Vec<String>,
|
||||
}
|
||||
|
||||
fn is_ascii_ws(c: char) -> bool {
|
||||
matches!(c, ' ' | '\t' | '\n' | '\r' | '\x0b' | '\x0c')
|
||||
}
|
||||
|
||||
impl Options {
|
||||
fn check_arg(&mut self, arg: &str) -> Result<Option<String>, ArgError> {
|
||||
if let Some(rest) = arg.strip_prefix("--class=") {
|
||||
self.class = Some(rest.trim_matches(is_ascii_ws).to_string());
|
||||
return Ok(None);
|
||||
}
|
||||
|
||||
if let Some(rest) = arg.strip_prefix("--working-directory=") {
|
||||
let stripped = rest.trim_matches(is_ascii_ws);
|
||||
if stripped == "home" || stripped == "inherit" {
|
||||
return Ok(Some(arg.to_string()));
|
||||
}
|
||||
let expanded =
|
||||
ghostty_os::expand_home(stripped).map_err(|e| ArgError::Other(e.to_string()))?;
|
||||
let realpath =
|
||||
std::fs::canonicalize(&expanded).map_err(|e| ArgError::Other(e.to_string()))?;
|
||||
self.working_directory_seen = true;
|
||||
return Ok(Some(format!(
|
||||
"--working-directory={}",
|
||||
realpath.to_string_lossy()
|
||||
)));
|
||||
}
|
||||
|
||||
Ok(Some(arg.to_string()))
|
||||
}
|
||||
}
|
||||
|
||||
impl CliTarget for Options {
|
||||
fn parse_into_field(&mut self, _key: &str, _value: Option<&str>) -> Result<(), ArgError> {
|
||||
Err(ArgError::InvalidField)
|
||||
}
|
||||
|
||||
/// Manual parse hook, collect all of the arguments after `+new-window`.
|
||||
fn parse_manually_hook(&mut self, arg: &str, iter: &mut dyn ArgIter) -> Result<bool, ArgError> {
|
||||
let mut e_seen = arg == "-e";
|
||||
|
||||
// Include the argument that triggered the manual parse hook.
|
||||
if let Some(a) = self.check_arg(arg)? {
|
||||
self.arguments.push(a);
|
||||
}
|
||||
|
||||
// Gather up the rest of the arguments to use as the command.
|
||||
while let Some(param) = iter.next_arg() {
|
||||
if e_seen {
|
||||
self.arguments.push(param);
|
||||
continue;
|
||||
}
|
||||
if param == "-e" {
|
||||
e_seen = true;
|
||||
self.arguments.push(param);
|
||||
continue;
|
||||
}
|
||||
if let Some(a) = self.check_arg(¶m)? {
|
||||
self.arguments.push(a);
|
||||
}
|
||||
}
|
||||
|
||||
Ok(false)
|
||||
}
|
||||
|
||||
fn supports_help(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn help(&mut self) -> Result<(), ArgError> {
|
||||
Err(ArgError::other(crate::error::HELP_ERROR_NAME))
|
||||
}
|
||||
}
|
||||
|
||||
/// The `new-window` will use native platform IPC to open up a new window in a
|
||||
/// running instance of Ghostty.
|
||||
///
|
||||
/// If the `--class` flag is not set, the `new-window` command will try and
|
||||
/// connect to a running instance of Ghostty based on what optimizations the
|
||||
/// Ghostty CLI was compiled with. Otherwise the `new-window` command will try
|
||||
/// and contact a running Ghostty instance that was configured with the same
|
||||
/// `class` as was given on the command line.
|
||||
///
|
||||
/// All of the arguments after the `+new-window` argument (except for the
|
||||
/// `--class` flag) will be sent to the remote Ghostty instance and will be
|
||||
/// parsed as command line flags. These flags will override certain settings
|
||||
/// when creating the first surface in the new window. Currently, only
|
||||
/// `--working-directory`, `--command`, and `--title` are supported. `-e` will
|
||||
/// also work as an alias for `--command`, except that if `-e` is found on the
|
||||
/// command line all following arguments will become part of the command and no
|
||||
/// more arguments will be parsed for configuration settings.
|
||||
///
|
||||
/// If `--working-directory` is found on the command line and is a relative
|
||||
/// path (i.e. doesn't start with `/`) it will be resolved to an absolute path
|
||||
/// relative to the current working directory that the `ghostty +new-window`
|
||||
/// command is run from. `~/` prefixes will also be expanded to the user's home
|
||||
/// directory.
|
||||
///
|
||||
/// If `--working-directory` is _not_ found on the command line, the working
|
||||
/// directory that `ghostty +new-window` is run from will be passed to Ghostty.
|
||||
///
|
||||
/// GTK uses an application ID to identify instances of applications. If Ghostty
|
||||
/// is compiled with release optimizations, the default application ID will be
|
||||
/// `com.mitchellh.ghostty`. If Ghostty is compiled with debug optimizations,
|
||||
/// the default application ID will be `com.mitchellh.ghostty-debug`. The
|
||||
/// `class` configuration entry can be used to set up a custom application
|
||||
/// ID. The class name must follow the requirements defined [in the GTK
|
||||
/// documentation](https://docs.gtk.org/gio/type_func.Application.id_is_valid.html)
|
||||
/// or it will be ignored and Ghostty will use the default as defined above.
|
||||
///
|
||||
/// On GTK, D-Bus activation must be properly configured. Ghostty does not need
|
||||
/// to be running for this to open a new window, making it suitable for binding
|
||||
/// to keys in your window manager (if other methods for configuring global
|
||||
/// shortcuts are unavailable). D-Bus will handle launching a new instance
|
||||
/// of Ghostty if it is not already running. See the Ghostty website for
|
||||
/// information on properly configuring D-Bus activation.
|
||||
///
|
||||
/// Only supported on GTK.
|
||||
///
|
||||
/// Flags:
|
||||
///
|
||||
/// * `--class=<class>`: If set, open up a new window in a custom instance of
|
||||
/// Ghostty. The class must be a valid GTK application ID.
|
||||
///
|
||||
/// * `--command`: The command to be executed in the first surface of the new window.
|
||||
///
|
||||
/// * `--working-directory=<directory>`: The working directory to pass to Ghostty.
|
||||
///
|
||||
/// * `--title`: A title that will override the title of the first surface in
|
||||
/// the new window. The title override may be edited or removed later.
|
||||
///
|
||||
/// * `-e`: Any arguments after this will be interpreted as a command to
|
||||
/// execute inside the first surface of the new window instead of the
|
||||
/// default command.
|
||||
///
|
||||
/// Available since: 1.2.0
|
||||
pub fn run(args: &[String]) -> Result<u8, Error> {
|
||||
let mut opts = Options::default();
|
||||
let mut iter = ghostty_config::cli_args::ArgsIterator::new(args.iter().skip(1).cloned());
|
||||
match ghostty_config::cli_args::parse(&mut opts, &mut iter) {
|
||||
Ok(()) => {}
|
||||
Err(ArgError::Other(n)) if n == crate::error::HELP_ERROR_NAME => {
|
||||
return Err(Error::ActionHelpRequested);
|
||||
}
|
||||
Err(err) => {
|
||||
eprintln!("Error parsing args: {err}");
|
||||
return Ok(1);
|
||||
}
|
||||
}
|
||||
|
||||
if !opts.working_directory_seen {
|
||||
// This should be inserted at the beginning of the list, just in case `-e` was used.
|
||||
let wd = std::fs::canonicalize(".")?;
|
||||
opts.arguments
|
||||
.insert(0, format!("--working-directory={}", wd.to_string_lossy()));
|
||||
}
|
||||
|
||||
// TODO(integration): send the `new_window` IPC (class: `opts.class` or
|
||||
// auto-detected, arguments: `opts.arguments`) via the GTK apprt's
|
||||
// `performIpc`.
|
||||
Err(Error::NotYetAvailable("new-window"))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#![allow(clippy::unwrap_used)]
|
||||
use super::*;
|
||||
use ghostty_config::cli_args::{VecIterator, parse};
|
||||
|
||||
fn parse_str(s: &str) -> Options {
|
||||
let mut opts = Options::default();
|
||||
let mut it = VecIterator::from_str_args(s);
|
||||
parse(&mut opts, &mut it).unwrap();
|
||||
opts
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn gathers_arguments_and_class() {
|
||||
let o = parse_str("--class=foo.bar --title=hi --command=ls");
|
||||
assert_eq!(Some("foo.bar".to_string()), o.class);
|
||||
assert_eq!(vec!["--title=hi", "--command=ls"], o.arguments);
|
||||
assert!(!o.working_directory_seen);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn everything_after_e_is_command() {
|
||||
let o = parse_str("--title=x -e --class=nope --working-directory=/nonexistent");
|
||||
assert_eq!(None, o.class);
|
||||
assert_eq!(
|
||||
vec![
|
||||
"--title=x",
|
||||
"-e",
|
||||
"--class=nope",
|
||||
"--working-directory=/nonexistent"
|
||||
],
|
||||
o.arguments
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn working_directory_is_resolved() {
|
||||
let o = parse_str("--working-directory=/");
|
||||
assert!(o.working_directory_seen);
|
||||
assert_eq!(vec!["--working-directory=/"], o.arguments);
|
||||
let o = parse_str("--working-directory=home");
|
||||
assert!(!o.working_directory_seen);
|
||||
assert_eq!(vec!["--working-directory=home"], o.arguments);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn help_is_gathered_not_special() {
|
||||
// Like Zig, the manual hook runs before the help check.
|
||||
let o = parse_str("--help");
|
||||
assert_eq!(vec!["--help"], o.arguments);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user