procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Display the exit code if the last command failed in Eshell

Browse source 
* lisp/eshell/esh-io.el (eshell-last-command-status): Make
buffer-local.

* lisp/eshell/em-prompt.el (eshell-prompt-function): Insert the exit
code if last command failed.

* test/lisp/eshell/em-prompt-tests.el (em-prompt-test/after-failure):
New test.
(em-prompt-test/next-previous-prompt-1)
(em-prompt-test/forward-backward-matching-input-1): Add a failing
command to tests.

* doc/misc/eshell.texi (Invocation): Document change.

* etc/NEWS: Announce change (bug#65604).
This commit is contained in:
Davide Masserut 2023-08-29 22:33:48 +02:00 • committed by Jim Porter
parent 6ae2b74ed2
commit 3d08d0dd80
5 changed files with 43 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/misc/eshell.texi
View file

@ -234,6 +234,9 @@ the foreground. That said, background processes invoked from Eshell
can be controlled the same way as any other background process in
Emacs.
If a command exits abnormally, Eshell will display its exit code
in the next prompt.
@subsection Command form
Command form looks much the same as in other shells. A command
consists of arguments separated by spaces; the first argument is the

3
etc/NEWS
View file

@ -370,6 +370,9 @@ to load the edited aliases.
Running 'rgrep' in Eshell now uses the Emacs grep facility instead of
calling external rgrep.
+++
*** If a command exits abnormally, the Eshell prompt now shows its exit code.
** Pcomplete
---

2
lisp/eshell/em-prompt.el
View file

@ -50,6 +50,8 @@ as is common with most shells."
(defcustom eshell-prompt-function
(lambda ()
(concat (abbreviate-file-name (eshell/pwd))
(unless (eshell-exit-success-p)
(format " [%d]" eshell-last-command-status))
(if (= (file-user-uid) 0) " # " " $ ")))
"A function that returns the Eshell prompt string."
:type 'function

2
lisp/eshell/esh-io.el
View file

@ -170,7 +170,7 @@ describing the mode, e.g. for using with `eshell-get-target'.")
(defvar eshell-current-handles nil)
(defvar eshell-last-command-status 0
(defvar-local eshell-last-command-status 0
"The exit code from the last command. 0 if successful.")
(defvar eshell-last-command-result nil

44
test/lisp/eshell/em-prompt-tests.el
View file

@ -85,20 +85,41 @@ This tests the case when `eshell-highlight-prompt' is nil."
(apply #'propertize "hello\n"
eshell-command-output-properties)))))))
(ert-deftest em-prompt-test/after-failure ()
"Check that current prompt shows the exit code of the last failed command."
(with-temp-eshell
(let ((debug-on-error nil))
(eshell-insert-command "(zerop \"foo\")"))
(let ((current-prompt (field-string (1- (point)))))
(should (equal-including-properties
current-prompt
(propertize
(concat (directory-file-name default-directory)
(unless (eshell-exit-success-p)
(format " [%d]" eshell-last-command-status))
(if (= (file-user-uid) 0) " # " " $ "))
'read-only t
'field 'prompt
'font-lock-face 'eshell-prompt
'front-sticky '(read-only field font-lock-face)
'rear-nonsticky '(read-only field font-lock-face)))))))
(defun em-prompt-test/next-previous-prompt-1 ()
"Helper for checking forward/backward navigation of old prompts."
(with-temp-eshell
(eshell-insert-command "echo one")
(eshell-insert-command "echo two")
(eshell-insert-command "echo three")
(let ((debug-on-error nil)) ; A failed command.
(eshell-insert-command "(zerop \"foo\")"))
(insert "echo fou") ; A partially-entered command.
(ert-info ("Go back one prompt")
(eshell-previous-prompt)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo three\n")))
(ert-info ("Go back two prompts, starting from the end of the input")
(should (equal (field-string) "(zerop \"foo\")\n")))
(ert-info ("Go back three prompts, starting from the end of the input")
(end-of-line)
(eshell-previous-prompt 2)
(eshell-previous-prompt 3)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo one\n")))
(ert-info ("Go to the current prompt, starting from the end of the input")
@ -110,20 +131,20 @@ This tests the case when `eshell-highlight-prompt' is nil."
(eshell-next-prompt)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo two\n")))
(ert-info ("Go forward two prompts")
(eshell-next-prompt 2)
(ert-info ("Go forward three prompts")
(eshell-next-prompt 3)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo fou")))
(ert-info ("Go back one prompt, starting from the beginning of the line")
(forward-line 0)
(eshell-previous-prompt 1)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo three\n")))
(should (equal (field-string) "(zerop \"foo\")\n")))
(ert-info ("Go back one prompt, starting from the previous prompt's output")
(forward-line -1)
(eshell-previous-prompt 1)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo two\n")))))
(should (equal (field-string) "echo three\n")))))
(ert-deftest em-prompt-test/next-previous-prompt ()
"Check that navigating forward/backward through old prompts works correctly."
@ -141,17 +162,20 @@ This tests the case when `eshell-highlight-prompt' is nil."
(eshell-insert-command "printnl something else")
(eshell-insert-command "echo two")
(eshell-insert-command "echo three")
(let ((debug-on-error nil)) ; A failed command.
(eshell-insert-command "(zerop \"foo\")"))
(insert "echo fou") ; A partially-entered command.
(ert-info ("Go back one prompt")
(ert-info ("Search for \"echo\", back one prompt")
(eshell-backward-matching-input "echo" 1)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo three\n")))
(ert-info ("Go back two prompts, starting from the end of this line")
(ert-info ((concat "Search for \"echo\", back two prompts, "
"starting from the end of this line"))
(end-of-line)
(eshell-backward-matching-input "echo" 2)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo one\n")))
(ert-info ("Go forward three prompts")
(ert-info ("Search for \"echo\", forward three prompts")
(eshell-forward-matching-input "echo" 3)
(should (equal (point) (field-beginning)))
(should (equal (field-string) "echo fou")))))