blob: 0439a46736eb66a9f75a72ab2c62968891dc6e9c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
;;; eshell-config.el --- Settings for the Emacs Shell -*- lexical-binding: t; coding: utf-8; -*-
;; author Craig Jennings <c@cjennings.net>
;;; Commentary:
;;
;; Layer: 3 (Domain Workflow).
;; Category: D/P.
;; Load shape: eager.
;; Eager reason: none; shell/REPL, a command/hook-loaded deferral candidate.
;; Top-level side effects: one add-hook, one advice-add, package config.
;; Runtime requires: system-utils.
;; Direct test load: yes.
;;
;; ESHELL
;; - Eshell is useful as a REPL
;; - Redirect to the kill ring : ls > /dev/kill
;; - Redirect to the clioboard : ls > /dev/clip
;; - Redirect to a buffer : ls > #<ls-output>
;; - Use elisp functions : write your own "detox" command in elisp
;; : then use it in eshell
;; - cd to remote directories : cd /sshx:c@cjennings.net:/home/cjennings
;; : and take all the elisp functionality remotely
;; : including Dired or Magit on a remote server
;;; Code:
(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)
:config
(setq eshell-banner-message "")
(setq eshell-scroll-to-bottom-on-input 'all)
(setq eshell-error-if-no-glob t)
(setq eshell-hist-ignoredups t)
(setq eshell-save-history-on-exit t)
(setq eshell-prefer-lisp-functions nil)
(setq eshell-destroy-buffer-when-process-dies t)
;; no pagers required
(setenv "PAGER" "cat")
(setq eshell-prompt-function
(lambda ()
(concat
(propertize (format-time-string "[%d-%m-%y %T]") 'face '(:foreground "gray"))
" "
(propertize (user-login-name) 'face '(:foreground "gray"))
" "
(propertize (system-name) 'face '(:foreground "gray"))
":"
(propertize (abbreviate-file-name (eshell/pwd)) 'face '(:foreground "gray"))
"\n"
(propertize "%" 'face '(:foreground "white"))
" ")))
(add-hook
'eshell-mode-hook
(lambda ()
(setq pcomplete-cycle-completions nil)))
(setq eshell-cmpl-cycle-completions nil)
(add-to-list 'eshell-modules-list 'eshell-tramp)
(add-hook 'eshell-hist-mode-hook
(lambda ()
(keymap-set eshell-hist-mode-map "<up>" #'previous-line)
(keymap-set eshell-hist-mode-map "<down>" #'next-line)))
(add-hook 'eshell-mode-hook
(lambda ()
(add-to-list 'eshell-visual-commands '("lf" "ranger" "tail" "htop" "gotop" "mc" "ncdu" "top"))
(add-to-list 'eshell-visual-subcommands '("git" "log" "diff" "show"))
(add-to-list 'eshell-visual-options '("git" "--help" "--paginate"))
;; aliases
(eshell/alias "e" "find-file $1")
(eshell/alias "em" "find-file $1")
(eshell/alias "emacs" "find-file $1")
(eshell/alias "open" "cj/xdg-open $1")
(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")
(eshell/alias "r" "ranger")
(eshell/alias "ll" "ls -laF"))))
(defun eshell/find-file-other-window (&rest files)
"Open FILE(s) in other window from eshell."
(if (= 1 (length files))
;; Single file - just use it directly
(find-file-other-window (car files))
;; Multiple files - open each in other window
(dolist (file files)
(find-file-other-window file))))
(defun eshell/find-file (&rest files)
"Open FILE(s) from eshell."
(if (= 1 (length files))
;; Single file
(find-file (car files))
;; Multiple files
(dolist (file files)
(find-file file))))
(defun eshell/clear ()
"Clear the eshell buffer."
(let ((inhibit-read-only t))
(erase-buffer)
(eshell-send-input)))
(defun eshell/find-using-dired (file-pattern)
"Find a file matching FILE-PATTERN using `find-name-dired'."
(let ((escaped-pattern (regexp-quote file-pattern)))
(find-name-dired default-directory escaped-pattern)))
(defun cj/eshell-delete-window-on-exit ()
"Close the eshell window when exiting."
(when (not (one-window-p))
(delete-window)))
(advice-add 'eshell-life-is-too-much :after 'cj/eshell-delete-window-on-exit)
(use-package eshell-toggle
:custom
(eshell-toggle-size-fraction 2)
(eshell-toggle-run-command nil)
(eshell-toggle-init-function #'eshell-toggle-init-eshell)
:bind
("C-<f12>" . eshell-toggle))
(use-package xterm-color
:after eshell
:hook
(eshell-before-prompt-hook . (lambda ()
(setq xterm-color-preserve-properties t)))
;; Scope `TERM=xterm-256color' to eshell-spawned processes only by
;; binding the env var on the eshell mode hook. The previous global
;; `setenv' at config-time changed `process-environment' for the
;; whole Emacs process, so every subsequent `start-process' inherited
;; `xterm-256color' regardless of whether the receiver was a terminal
;; that could actually interpret the escapes.
:hook
(eshell-mode . (lambda ()
(setq-local process-environment
(cons "TERM=xterm-256color"
process-environment)))))
(use-package eshell-syntax-highlighting
:after esh-mode
:config
(eshell-syntax-highlighting-global-mode +1))
(use-package eshell-up
:after eshell
:config
(defalias 'eshell/up 'eshell-up)
(defalias 'eshell/up-peek 'eshell-up-peek))
;; Enhance history searching
(defun cj/eshell-history-search ()
"Search eshell history with completion."
(interactive)
(insert
(completing-read "Eshell history: "
(delete-dups
(ring-elements eshell-history-ring)))))
(add-hook 'eshell-mode-hook
(lambda ()
(keymap-set eshell-mode-map "C-r" #'cj/eshell-history-search)))
;; Better completion for eshell
(use-package pcmpl-args
:after eshell)
;; Company mode integration for eshell
(use-package company-shell
:after (eshell company)
:config
(add-to-list 'company-backends 'company-shell)
(add-hook 'eshell-mode-hook
(lambda ()
(setq-local company-minimum-prefix-length 2)
(setq-local company-idle-delay 2)
(company-mode 1))))
(provide 'eshell-config)
;;; eshell-config.el ends here.
|
