feat(vterm): advice instead to prefer project-specific buffer

CHANGELOG.md

@@ -13,6 +13,8 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 ### Changed
 
 - Clocking out now prompts the user to select the next state.
+- Instead of providing `wal-project-vterm`, `vterm` is now advised to
+ prefer using a project-specific buffer.
 
 ## [2.2.7]
 

lib/wal-terminal.org

@@ -125,33 +125,42 @@ Adds the same functionality to have one =vterm= buffer per project and
 sets up =with-editor=.
 
 #+BEGIN_SRC emacs-lisp
-(defun wal-project-vterm (&optional force)
- "Get a project `vterm' buffer.
+(defun wal-vterm--prefer-project (fun &optional arg)
+ "Get preferably a `vterm' buffer.
 
-If FORCE is non-nil, this creates a new buffer even if a project
-buffer already exists."
+This calls FUN (which is `vterm'). If there is a project and ARG
+is non-nil, this creates a new buffer even if a project buffer
+already exists."
  (interactive "P")
 
- (let* ((default-directory (project-root (project-current t)))
- (vterm-buffer-name (project-prefixed-buffer-name "vterm"))
- (buffer (get-buffer vterm-buffer-name)))
+ (if-let ((project (project-current)))
 
- (if (and buffer (not force))
- (pop-to-buffer buffer (bound-and-true-p display-comint-buffer-action))
- (vterm t))))
+ (let* ((default-directory (project-root project))
+ (vterm-buffer-name (project-prefixed-buffer-name "vterm"))
+ (buffer (get-buffer vterm-buffer-name)))
+
+ (if (and buffer (not arg))
+ (pop-to-buffer buffer (bound-and-true-p display-comint-buffer-action))
+
+ (funcall fun t)))
+
+ (funcall fun arg)))
 
 (use-package vterm
  :hook
  (vterm-mode . with-editor-export-git-editor)
 
+ :init
+ (advice-add
+ 'vterm :around
+ #'wal-vterm--prefer-project)
+
  :custom
  (vterm-prefix "VTerm")
  (vterm-max-scrollback 10000)
 
  :general
- (ambassador "t" '(:ignore t :wk "vterm")
- "tt" 'vterm
- "tp" 'wal-project-vterm)
+ (ambassador "t" 'vterm)
 
  :delight
  (vterm-copy-mode " vcp"))

test/wal-terminal-test.el

@@ -16,30 +16,41 @@
 
  (bydi-was-called eshell-truncate-buffer)))
 
-(ert-deftest wal-project-vterm ()
- (bydi ((:always project-current)
+(ert-deftest wal-vterm--prefer-project ()
+ :tags '(terminal)
+
+ (defun faketerm (&rest args)
+ t)
+
+ (bydi ((:sometimes project-current)
  (:mock project-root :return "/tmp")
  (:mock project-prefixed-buffer-name :return "*test-vterm*")
  (:spy pop-to-buffer)
- (:watch default-directory)
- vterm)
+ (:spy faketerm)
+ (:watch default-directory))
 
- (wal-project-vterm)
+ (wal-vterm--prefer-project 'faketerm t)
 
- (bydi-was-called vterm)
+ (bydi-was-called faketerm)
  (bydi-was-set-to default-directory "/tmp")
 
  (ert-with-test-buffer (:name "vterm")
  (rename-buffer "*test-vterm*")
 
- (funcall-interactively 'wal-project-vterm t)
+ (funcall-interactively 'wal-vterm--prefer-project 'faketerm t)
 
- (bydi-was-called vterm)
+ (bydi-was-called faketerm)
  (bydi-was-not-called pop-to-buffer)
 
- (wal-project-vterm)
+ (wal-vterm--prefer-project 'faketerm)
+
+ (bydi-was-called pop-to-buffer))
+
+ (bydi-toggle-sometimes)
+
+ (funcall-interactively 'wal-vterm--prefer-project 'faketerm 'argument)
 
-  (bydi-was-called pop-to-buffer))))
+ (bydi-was-called-last-with faketerm 'argument)))
 
 ;;; wal-terminal-test.el ends here