consult-any-project-buffer

[xendk]

I had an idea for an alternative consult-buffer I thought of. As a oneliner:

consult-buffer grouped by project.

Rationale:
I use project-find-file (vertico enhanced) all day, but never got used to project-switch-to-buffer (or the project prefix in consult-buffer), so having the current projects files as the first group would be nice.

Secondly, I often find myself juggling multiple projects, often with similarly named files, so having the group header identify the project of each buffer when narrowing would be a major plus.

Thirdly, if the project group ordering follows the "recently visited" ordering of the buffers, the "open the last buffer I touched in the previous project" becomes the no-brainer C-x b C-<down> RET, which is also nice.

It would seem to be technically viable, as ibuffer does this kind of grouping. Though i suspect it's a challenge to combine it with the hidden/modified filters.

Anyone else think this could be nice?

[xendk]

After some messing about, I got the following, which seems to fit the ticket (not much tested yet):

(defun +consult-buffer-by-project (&optional sources)
  "Variant of `consult-buffer' that groups by project."
  (interactive)
  (let ((selected (consult--multi (or sources consult-buffer-sources)
                                  :require-match
                                  (confirm-nonexistent-file-or-buffer)
                                  :prompt "Switch to: "
                                  :history 'consult--buffer-history
                                  :sort nil
                                  :group #'+consult--multi-group-by-project
                                  )))
    ;; For non-matching candidates, fall back to buffer creation.
    (unless (plist-get (cdr selected) :match)
      (consult--buffer-action (car selected)))))

(defun +consult--multi-group-by-project (cand transform)
  (if transform
      cand
    (let* ((default-directory (buffer-local-value 'default-directory (get-buffer (cdr (get-text-property 0 'multi-category cand)))))
           (project (project-current nil)))
      (if project
          (project-root project)
        "<no project>"))))