aboutsummaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-25 18:29:31 -0500
committerCraig Jennings <c@cjennings.net>2026-05-25 18:29:31 -0500
commit937be691cd921eeaebac0349782d985edba820cd (patch)
tree63d0bb28e5d18e6b7220090330cc88eb3f18e14c /modules
parent7ce43f29a754d68db5a3c8683f01e7f9698a32e8 (diff)
downloaddotemacs-937be691cd921eeaebac0349782d985edba820cd.tar.gz
dotemacs-937be691cd921eeaebac0349782d985edba820cd.zip
refactor(eshell): move SSH-jump hosts into a defcustom
The eshell SSH-jump aliases (gocj, gosb, gowolf) were hardcoded inline in the alias setup, which tied the module to my machines. I moved them into a cj/eshell-ssh-hosts defcustom (an alias→remote-path alist, defaulting to my current hosts) and build the aliases by iterating it. A different machine can override the variable or set it to nil instead of editing the module. Extracted a pure cj/--eshell-ssh-alias-commands helper so the alias construction is testable without a live eshell.
Diffstat (limited to 'modules')
-rw-r--r--modules/eshell-config.el35
1 files changed, 32 insertions, 3 deletions
diff --git a/modules/eshell-config.el b/modules/eshell-config.el
index 64bc88c6..0439a467 100644
--- a/modules/eshell-config.el
+++ b/modules/eshell-config.el
@@ -26,6 +26,37 @@
(require 'system-utils)
+(defgroup cj/eshell nil
+ "Personal Eshell configuration."
+ :group 'eshell)
+
+(defcustom cj/eshell-ssh-hosts
+ '(("gocj" . "/sshx:cjennings@cjennings.net:/var/cjennings/")
+ ("gosb" . "/sshx:cjennings@wolf.usbx.me:/home/cjennings/")
+ ("gowolf" . "/sshx:cjennings@wolf.usbx.me:/home/cjennings/"))
+ "Alist of Eshell SSH-jump aliases.
+Each entry is a cons cell (ALIAS-NAME . REMOTE-PATH). At Eshell
+startup an alias named ALIAS-NAME is defined that runs `cd' to the
+given TRAMP REMOTE-PATH. Override on a different machine to point at
+your own hosts, or set to nil to define no SSH aliases."
+ :type '(alist :key-type (string :tag "Alias")
+ :value-type (string :tag "Remote path"))
+ :group 'cj/eshell)
+
+(defun cj/--eshell-ssh-alias-commands (hosts)
+ "Return the SSH alias definitions for HOSTS.
+HOSTS is an alist of (ALIAS-NAME . REMOTE-PATH) as in
+`cj/eshell-ssh-hosts'. The result is a list of (ALIAS-NAME . COMMAND)
+pairs where COMMAND is the `cd' string `eshell/alias' should run."
+ (mapcar (lambda (entry)
+ (cons (car entry) (concat "cd " (cdr entry))))
+ hosts))
+
+(defun cj/--eshell-define-ssh-aliases (hosts)
+ "Define the Eshell SSH-jump aliases for HOSTS via `eshell/alias'."
+ (dolist (pair (cj/--eshell-ssh-alias-commands hosts))
+ (eshell/alias (car pair) (cdr pair))))
+
(use-package eshell
:ensure nil ;; built-in
:commands (eshell)
@@ -79,9 +110,7 @@
(eshell/alias "em" "find-file $1")
(eshell/alias "emacs" "find-file $1")
(eshell/alias "open" "cj/xdg-open $1")
- (eshell/alias "gocj" "cd /sshx:cjennings@cjennings.net:/var/cjennings/")
- (eshell/alias "gosb" "cd /sshx:cjennings@wolf.usbx.me:/home/cjennings/")
- (eshell/alias "gowolf" "cd /sshx:cjennings@wolf.usbx.me:/home/cjennings/")
+ (cj/--eshell-define-ssh-aliases cj/eshell-ssh-hosts)
(eshell/alias "v" "eshell-exec-visual $*")
(eshell/alias "ff" "find-file-other-window $1")
(eshell/alias "f" "find-using-dired $1")