Add ghostel-project-dwim - #620

Thanks for the PR.

I'm in the process of overhauling the whole public API anyway.
I'll have to sleep a night or two over your PR.
At first glance it's not necessarily what I would assume a -dwim command does,
it's basically just ghostel-project but when there are more than 1 buffer in the project it's ghostel-project-list-buffers.

Yep, it's basically a convenience wrapper over those two commands, picking the right one situationally. No worries if this isn't accepted, I'm just tinkering and contributing in case it's useful to others. :) Out of curiosity, what was your expectation for a dwim command?

In case it helps for the public API, here's my research into what's provided by other packages.

• "Named always-create" means whether there's a dedicated function to always create a new project terminal. For ghostel the answer would be no, which follows the dominant convention (call the project command with C-u to force a new project terminal).
• For the final column ("Several-terminals"), I believe that ghostel combines prior art by accepting both numeric indices and cycling, which I think is sensible.

I've updated my personal dwim command to build on the recently-added consult-ghostel functionality:

  (defun ghostel-project-dwim (&optional arg)
    "Create, switch to, or consult-pick this project's ghostel terminal.
With prefix ARG, force a new terminal via `ghostel-project'."
    (interactive "P")
    (let ((bufs (and (not arg) (project-current nil)
                     (ghostel-project-buffer-list))))
      (cond ((or arg (null bufs)) (ghostel-project arg))
            ((null (cdr bufs))
             (pop-to-buffer (car bufs)
                            (append display-buffer--same-window-action
                                    '((category . comint)))))
            (t (consult-ghostel-project)))))

The result? Why it looks splendid (and works intuitively!).

@mrcnski I'm thinking of changing the default behaviour of consult-ghostel(-project) to yours.
Or at least when there is no Terminal to just create one.
I don't think for consult-xxx commands there is a precedence like for the other terminal commands so it's not confusing other users (e.g. M-x ghostel has to behave like it does because M-x term, M-x vterm etc all behave the same).
What do you think?

Thanks for considering this and sharing your thoughts.

Regarding ghostel keeping precedent with term, vterm etc.: completely agreed here. In case it wasn't clear, my proposal was not about affecting the behavior of existing commands but about adding a new command, named something like ghostel-dwim.

About the consult commands getting some (or all) of the dwim behavior: here I think we should look at what existing consult commands do, and opt for consistency. I had Fable look at them and it found that "no built-in [consult command] bypasses the minibuffer when there is exactly one candidate" and that "there is [...] a general consult precedent, and the current consult-ghostel already fits it".

So here I think the more ergonomic functionality should live in a wrapper around the default consult ghostel commands - maybe documented somewhere like the README if it's too opinionated to bundle with the package.