refactor: extract SSH cache functionality to shared script

Addresses feedback about separation of concerns in shell integration
scripts.

Extracts host caching logic to
`src/shell-integration/shared/ghostty-ssh-cache` and updates all four
shell integrations to use the shared script. The `shared/` subdirectory
preserves the existing organizational pattern where all shell-specific
code lives in subdirectories. This cleanly separates SSH transport logic
from cache management while reducing code duplication by ~25%.

All existing SSH integration behavior remains identical.
This commit is contained in:
Jason Rayne
2025-06-24 17:15:35 -07:00
parent bbb02a8392
commit 8a2fa6485e
5 changed files with 174 additions and 282 deletions

View File

@ -97,56 +97,48 @@ fi
# SSH Integration
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-(env|terminfo) ]]; then
# Only define cache functions and variable if ssh-terminfo is enabled
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
_cache="${XDG_STATE_HOME:-$HOME/.local/state}/ghostty/terminfo_hosts"
# Cache operations and utilities
_ghst_cache() {
case $2 in
chk) [[ -f $_cache ]] && grep -qFx "$1" "$_cache" 2>/dev/null ;;
add)
mkdir -p "${_cache%/*}"
{
[[ -f $_cache ]] && cat "$_cache"
builtin echo "$1"
} | sort -u >"$_cache.tmp" && mv "$_cache.tmp" "$_cache" && chmod 600 "$_cache"
;;
readonly _CACHE="${GHOSTTY_RESOURCES_DIR}/shell-integration/shared/ghostty-ssh-cache"
# If 'ssh-terminfo' flag is enabled, wrap ghostty to provide cache management commands
ghostty() {
case "$1" in
ssh-cache-list) "$_CACHE" list ;;
ssh-cache-clear) "$_CACHE" clear ;;
*) builtin command ghostty "$@" ;;
esac
}
function ghostty_ssh_cache_clear() {
rm -f "$_cache" 2>/dev/null && builtin echo "Ghostty SSH terminfo cache cleared." || builtin echo "No Ghostty SSH terminfo cache found."
}
function ghostty_ssh_cache_list() {
[[ -s $_cache ]] && builtin echo "Hosts with Ghostty terminfo installed:" && cat "$_cache" || builtin echo "No cached hosts found."
}
fi
# SSH wrapper
ssh() {
local e=() o=() c=() t
# Get target
t=$(builtin command ssh -G "$@" 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@')
local e=() o=() c=() # Removed 't' from here
# Set up env vars first so terminfo installation inherits them
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-env ]]; then
builtin export COLORTERM=${COLORTERM:-truecolor} TERM_PROGRAM=${TERM_PROGRAM:-ghostty} ${GHOSTTY_VERSION:+TERM_PROGRAM_VERSION=$GHOSTTY_VERSION}
for v in COLORTERM=truecolor TERM_PROGRAM=ghostty ${GHOSTTY_VERSION:+TERM_PROGRAM_VERSION=$GHOSTTY_VERSION}; do
local vars=(
COLORTERM=truecolor
TERM_PROGRAM=ghostty
${GHOSTTY_VERSION:+TERM_PROGRAM_VERSION=$GHOSTTY_VERSION}
)
for v in "${vars[@]}"; do
builtin export "${v?}"
o+=(-o "SendEnv ${v%=*}" -o "SetEnv $v")
done
fi
# Install terminfo if needed, reuse control connection for main session
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
if [[ -n $t ]] && _ghst_cache "$t" chk; then
# Get target (only when needed for terminfo)
builtin local t
t=$(builtin command ssh -G "$@" 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@')
if [[ -n "$t" ]] && "$_CACHE" chk "$t"; then
e+=(TERM=xterm-ghostty)
elif builtin command -v infocmp >/dev/null 2>&1; then
builtin local ti
ti=$(infocmp -x xterm-ghostty 2>/dev/null) || builtin echo "Warning: xterm-ghostty terminfo not found locally." >&2
if [[ -n $ti ]]; then
if [[ -n "$ti" ]]; then
builtin echo "Setting up Ghostty terminfo on remote host..." >&2
builtin local cp
cp="/tmp/ghostty-ssh-$USER-$RANDOM-$(date +%s)"
@ -157,7 +149,7 @@ if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-(env|terminfo) ]]; then
') in
OK)
builtin echo "Terminfo setup complete." >&2
[[ -n $t ]] && _ghst_cache "$t" add
[[ -n "$t" ]] && "$_CACHE" add "$t"
e+=(TERM=xterm-ghostty)
c+=(-o "ControlPath=$cp")
;;
@ -181,17 +173,6 @@ if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-(env|terminfo) ]]; then
builtin command ssh "${o[@]}" "${c[@]}" "$@"
fi
}
# If 'ssh-terminfo' flag is enabled, wrap ghostty to provide 'ghostty ssh-cache-list' and `ghostty ssh-cache-clear` utility commands
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
ghostty() {
case "$1" in
ssh-cache-list) ghostty_ssh_cache_list ;;
ssh-cache-clear) ghostty_ssh_cache_clear ;;
*) builtin command ghostty "$@" ;;
esac
}
fi
fi
# Import bash-preexec, safe to do multiple times

View File

@ -104,53 +104,21 @@
use re
if (re:match 'ssh-(env|terminfo)' $E:GHOSTTY_SHELL_FEATURES) {
# Only define cache functions and variable if ssh-terminfo is enabled
if (re:match 'ssh-terminfo' $E:GHOSTTY_SHELL_FEATURES) {
var _cache = (path:join (or $E:XDG_STATE_HOME $E:HOME/.local/state) ghostty terminfo_hosts)
var _cache_script = (path:join $E:GHOSTTY_RESOURCES_DIR shell-integration shared ghostty-ssh-cache)
# Cache operations and utilities
fn _ghst_cache {|target action|
if (eq $action chk) {
if (path:is-regular $_cache) {
try {
grep -qFx $target $_cache 2>/dev/null
} catch e {
fail
}
# Wrap ghostty command to provide cache management commands
fn ghostty {|@args|
if (eq $args[0] ssh-cache-list) {
(external $_cache_script) list
} elif (eq $args[0] ssh-cache-clear) {
(external $_cache_script) clear
} else {
fail
}
} elif (eq $action add) {
mkdir -p (path:dir $_cache)
var tmpfile = $_cache.tmp
{
if (path:is-regular $_cache) {
cat $_cache
}
echo $target
} | sort -u > $tmpfile
mv $tmpfile $_cache
chmod 600 $_cache
(external ghostty) $@args
}
}
fn ghostty_ssh_cache_clear {
try {
rm -f $_cache 2>/dev/null
echo "Ghostty SSH terminfo cache cleared."
} catch e {
echo "No Ghostty SSH terminfo cache found."
}
}
fn ghostty_ssh_cache_list {
if (and (path:is-regular $_cache) (> (wc -c < $_cache | str:trim-space) 0)) {
echo "Hosts with Ghostty terminfo installed:"
cat $_cache
} else {
echo "No cached hosts found."
}
}
edit:add-var ghostty~ $ghostty~
}
# SSH wrapper
@ -158,16 +126,6 @@
var e = []
var o = []
var c = []
var t = ""
# Get target (only if ssh-terminfo enabled for caching)
if (re:match 'ssh-terminfo' $E:GHOSTTY_SHELL_FEATURES) {
try {
set t = (e:ssh -G $@args 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@' | str:trim-space)
} catch e {
# Ignore errors
}
}
# Set up env vars first so terminfo installation inherits them
if (re:match 'ssh-env' $E:GHOSTTY_SHELL_FEATURES) {
@ -189,7 +147,15 @@
# Install terminfo if needed, reuse control connection for main session
if (re:match 'ssh-terminfo' $E:GHOSTTY_SHELL_FEATURES) {
if (and (not-eq $t "") (try { _ghst_cache $t chk } catch e { put $false })) {
# Get target (only when needed for terminfo)
var t = ""
try {
set t = (e:ssh -G $@args 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@' | str:trim-space)
} catch e {
# Ignore errors
}
if (and (not-eq $t "") (try { (external $_cache_script) chk $t } catch e { put $false })) {
set e = [$@e TERM=xterm-ghostty]
} elif (has-external infocmp) {
var ti = ""
@ -209,7 +175,7 @@
if (eq $result OK) {
echo "Terminfo setup complete." >&2
if (not-eq $t "") {
_ghst_cache $t add
(external $_cache_script) add $t
}
set e = [$@e TERM=xterm-ghostty]
set c = [$@c -o ControlPath=$cp]
@ -237,25 +203,6 @@
}
}
# Wrap ghostty command only if ssh-terminfo is enabled
if (re:match 'ssh-terminfo' $E:GHOSTTY_SHELL_FEATURES) {
fn ghostty {|@args|
if (eq $args[0] ssh-cache-list) {
ghostty_ssh_cache_list
} elif (eq $args[0] ssh-cache-clear) {
ghostty_ssh_cache_clear
} else {
(external ghostty) $@args
}
}
edit:add-var ghostty~ $ghostty~
# Export cache functions for global use
set edit:add-var[ghostty_ssh_cache_clear] = $ghostty_ssh_cache_clear~
set edit:add-var[ghostty_ssh_cache_list] = $ghostty_ssh_cache_list~
}
# Export ssh function for global use
set edit:add-var[ssh] = $ssh~
}

View File

@ -63,14 +63,14 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
# When using sudo shell integration feature, ensure $TERMINFO is set
# and `sudo` is not already a function or alias
if contains sudo $features; and test -n "$TERMINFO"; and test "file" = (type -t sudo 2> /dev/null; or echo "x")
if contains sudo $features; and test -n "$TERMINFO"; and test file = (type -t sudo 2> /dev/null; or echo "x")
# Wrap `sudo` command to ensure Ghostty terminfo is preserved
function sudo -d "Wrap sudo to preserve terminfo"
set --function sudo_has_sudoedit_flags "no"
set --function sudo_has_sudoedit_flags no
for arg in $argv
# Check if argument is '-e' or '--edit' (sudoedit flags)
if string match -q -- "-e" "$arg"; or string match -q -- "--edit" "$arg"
set --function sudo_has_sudoedit_flags "yes"
if string match -q -- -e "$arg"; or string match -q -- --edit "$arg"
set --function sudo_has_sudoedit_flags yes
break
end
# Check if argument is neither an option nor a key-value pair
@ -78,7 +78,7 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
break
end
end
if test "$sudo_has_sudoedit_flags" = "yes"
if test "$sudo_has_sudoedit_flags" = yes
command sudo $argv
else
command sudo TERMINFO="$TERMINFO" $argv
@ -88,31 +88,20 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
# SSH Integration
if string match -qr 'ssh-(env|terminfo)' "$GHOSTTY_SHELL_FEATURES"
# Only define cache functions and variable if ssh-terminfo is enabled
if string match -qr 'ssh-terminfo' "$GHOSTTY_SHELL_FEATURES"
set -g _cache (test -n "$XDG_STATE_HOME" && echo "$XDG_STATE_HOME" || echo "$HOME/.local/state")/ghostty/terminfo_hosts
if string match -qr ssh-terminfo "$GHOSTTY_SHELL_FEATURES"
set -g _cache_script "$GHOSTTY_RESOURCES_DIR/shell-integration/shared/ghostty-ssh-cache"
# Cache operations and utilities
function _ghst_cache
switch $argv[2]
case chk
test -f $_cache && grep -qFx "$argv[1]" "$_cache" 2>/dev/null
case add
mkdir -p (dirname "$_cache")
begin
test -f $_cache && cat "$_cache"
builtin echo "$argv[1]"
end | sort -u >"$_cache.tmp" && mv "$_cache.tmp" "$_cache" && chmod 600 "$_cache"
# Wrap ghostty command to provide cache management commands
function ghostty -d "Wrap ghostty to provide cache management commands"
switch "$argv[1]"
case ssh-cache-list
command "$_cache_script" list
case ssh-cache-clear
command "$_cache_script" clear
case "*"
command ghostty $argv
end
end
function ghostty_ssh_cache_clear -d "Clear Ghostty SSH terminfo cache"
rm -f "$_cache" 2>/dev/null && builtin echo "Ghostty SSH terminfo cache cleared." || builtin echo "No Ghostty SSH terminfo cache found."
end
function ghostty_ssh_cache_list -d "List hosts with Ghostty terminfo installed"
test -s $_cache && builtin echo "Hosts with Ghostty terminfo installed:" && cat "$_cache" || builtin echo "No cached hosts found."
end
end
# SSH wrapper
@ -120,28 +109,28 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
set -l e
set -l o
set -l c
set -l t
# Get target (only if ssh-terminfo enabled for caching)
if string match -qr 'ssh-terminfo' "$GHOSTTY_SHELL_FEATURES"
set t (builtin command ssh -G $argv 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@')
end
# Set up env vars first so terminfo installation inherits them
if string match -qr 'ssh-env' "$GHOSTTY_SHELL_FEATURES"
if string match -qr ssh-env "$GHOSTTY_SHELL_FEATURES"
set -gx COLORTERM (test -n "$COLORTERM" && echo "$COLORTERM" || echo "truecolor")
set -gx TERM_PROGRAM (test -n "$TERM_PROGRAM" && echo "$TERM_PROGRAM" || echo "ghostty")
test -n "$GHOSTTY_VERSION" && set -gx TERM_PROGRAM_VERSION "$GHOSTTY_VERSION"
for v in COLORTERM=truecolor TERM_PROGRAM=ghostty (test -n "$GHOSTTY_VERSION" && echo "TERM_PROGRAM_VERSION=$GHOSTTY_VERSION")
set -l vars COLORTERM=truecolor TERM_PROGRAM=ghostty
test -n "$GHOSTTY_VERSION" && set vars $vars "TERM_PROGRAM_VERSION=$GHOSTTY_VERSION"
for v in $vars
set -l varname (string split -m1 '=' "$v")[1]
set o $o -o "SendEnv $varname" -o "SetEnv $v"
end
end
# Install terminfo if needed, reuse control connection for main session
if string match -qr 'ssh-terminfo' "$GHOSTTY_SHELL_FEATURES"
if test -n "$t" && _ghst_cache "$t" chk
if string match -qr ssh-terminfo "$GHOSTTY_SHELL_FEATURES"
# Get target (only when needed for terminfo)
set -l t (builtin command ssh -G $argv 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@')
if test -n "$t" && command "$_cache_script" chk "$t"
set e $e TERM=xterm-ghostty
else if command -v infocmp >/dev/null 2>&1
set -l ti
@ -157,7 +146,7 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
switch $result
case OK
builtin echo "Terminfo setup complete." >&2
test -n "$t" && _ghst_cache "$t" add
test -n "$t" && command "$_cache_script" add "$t"
set e $e TERM=xterm-ghostty
set c $c -o "ControlPath=$cp"
case '*'
@ -170,7 +159,7 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
end
# Fallback TERM only if terminfo didn't set it
if string match -qr 'ssh-env' "$GHOSTTY_SHELL_FEATURES"
if string match -qr ssh-env "$GHOSTTY_SHELL_FEATURES"
if test "$TERM" = xterm-ghostty && not string match -q '*TERM=*' "$e"
set e $e TERM=xterm-256color
end
@ -183,20 +172,6 @@ function __ghostty_setup --on-event fish_prompt -d "Setup ghostty integration"
builtin command ssh $o $c $argv
end
end
# Wrap ghostty command only if ssh-terminfo is enabled
if string match -qr 'ssh-terminfo' "$GHOSTTY_SHELL_FEATURES"
function ghostty -d "Wrap ghostty to provide cache management commands"
switch "$argv[1]"
case ssh-cache-list
ghostty_ssh_cache_list
case ssh-cache-clear
ghostty_ssh_cache_clear
case "*"
command ghostty $argv
end
end
end
end
# Setup prompt marking

View File

@ -0,0 +1,11 @@
#!/usr/bin/env bash
# Minimal Ghostty SSH terminfo host cache
readonly CACHE_FILE="${XDG_STATE_HOME:-$HOME/.local/state}/ghostty/terminfo_hosts"
case "${1:-}" in
chk) [[ -f "$CACHE_FILE" ]] && grep -qFx "$2" "$CACHE_FILE" 2>/dev/null ;;
add) mkdir -p "${CACHE_FILE%/*}"; { [[ -f "$CACHE_FILE" ]] && cat "$CACHE_FILE"; echo "$2"; } | sort -u > "$CACHE_FILE.tmp" && mv "$CACHE_FILE.tmp" "$CACHE_FILE" && chmod 600 "$CACHE_FILE" ;;
list) [[ -s "$CACHE_FILE" ]] && echo "Hosts with Ghostty terminfo installed:" && cat "$CACHE_FILE" || echo "No cached hosts found." ;;
clear) rm -f "$CACHE_FILE" 2>/dev/null && echo "Ghostty SSH terminfo cache cleared." || echo "No Ghostty SSH terminfo cache found." ;;
esac

View File

@ -246,54 +246,43 @@ _ghostty_deferred_init() {
# SSH Integration
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-(env|terminfo) ]]; then
# Only define cache functions and variable if ssh-terminfo is enabled
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
_cache="${XDG_STATE_HOME:-$HOME/.local/state}/ghostty/terminfo_hosts"
readonly _cache_script="${GHOSTTY_RESOURCES_DIR}/shell-integration/shared/ghostty-ssh-cache"
# Cache operations and utilities
_ghst_cache() {
case $2 in
chk) [[ -f $_cache ]] && grep -qFx "$1" "$_cache" 2>/dev/null ;;
add)
mkdir -p "${_cache:h}"
{
[[ -f $_cache ]] && cat "$_cache"
builtin echo "$1"
} | sort -u >"$_cache.tmp" && mv "$_cache.tmp" "$_cache" && chmod 600 "$_cache"
;;
# Wrap ghostty command to provide cache management commands
ghostty() {
case "$1" in
ssh-cache-list) "$_cache_script" list ;;
ssh-cache-clear) "$_cache_script" clear ;;
*) builtin command ghostty "$@" ;;
esac
}
ghostty_ssh_cache_clear() {
rm -f "$_cache" 2>/dev/null && builtin echo "Ghostty SSH terminfo cache cleared." || builtin echo "No Ghostty SSH terminfo cache found."
}
ghostty_ssh_cache_list() {
[[ -s $_cache ]] && builtin echo "Hosts with Ghostty terminfo installed:" && cat "$_cache" || builtin echo "No cached hosts found."
}
fi
# SSH wrapper
ssh() {
local -a e o c
local t
# Get target (only if ssh-terminfo enabled for caching)
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
t=$(builtin command ssh -G "$@" 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@')
fi
# Set up env vars first so terminfo installation inherits them
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-env ]]; then
builtin export COLORTERM=${COLORTERM:-truecolor} TERM_PROGRAM=${TERM_PROGRAM:-ghostty} ${GHOSTTY_VERSION:+TERM_PROGRAM_VERSION=$GHOSTTY_VERSION}
for v in COLORTERM=truecolor TERM_PROGRAM=ghostty ${GHOSTTY_VERSION:+TERM_PROGRAM_VERSION=$GHOSTTY_VERSION}; do
local vars=(
COLORTERM=truecolor
TERM_PROGRAM=ghostty
${GHOSTTY_VERSION:+TERM_PROGRAM_VERSION=$GHOSTTY_VERSION}
)
for v in "${vars[@]}"; do
builtin export "${v?}"
o+=(-o "SendEnv ${v%=*}" -o "SetEnv $v")
done
fi
# Install terminfo if needed, reuse control connection for main session
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
if [[ -n $t ]] && _ghst_cache "$t" chk; then
# Get target (only when needed for terminfo)
builtin local t
t=$(builtin command ssh -G "$@" 2>/dev/null | awk '/^(user|hostname) /{print $2}' | paste -sd'@')
if [[ -n $t ]] && "$_cache_script" chk "$t"; then
e+=(TERM=xterm-ghostty)
elif builtin command -v infocmp >/dev/null 2>&1; then
local ti
@ -309,7 +298,7 @@ _ghostty_deferred_init() {
') in
OK)
builtin echo "Terminfo setup complete." >&2
[[ -n $t ]] && _ghst_cache "$t" add
[[ -n $t ]] && "$_cache_script" add "$t"
e+=(TERM=xterm-ghostty)
c+=(-o "ControlPath=$cp")
;;
@ -333,17 +322,6 @@ _ghostty_deferred_init() {
builtin command ssh "${o[@]}" "${c[@]}" "$@"
fi
}
# Wrap ghostty command only if ssh-terminfo is enabled
if [[ "$GHOSTTY_SHELL_FEATURES" =~ ssh-terminfo ]]; then
ghostty() {
case "$1" in
ssh-cache-list) ghostty_ssh_cache_list ;;
ssh-cache-clear) ghostty_ssh_cache_clear ;;
*) builtin command ghostty "$@" ;;
esac
}
fi
fi
# Some zsh users manually run `source ~/.zshrc` in order to apply rc file