consult-flymake at point

[grolongo]

Hello minad,

Is it possible for consult-flymake when invoked to go directly to the warning/error under point? Let me explain:

I have 50 warnings/errors in my buffer, the cursor is currently hovering a symbol which has been flagged by flymake, on line 2910. I want to look up the error message, so I invoke M-x consult-flymake. The problem is the minibuffer is showing the list of warnings/errors from the very beginning, and I have to either C-n, type the line number or the keyword to narrow it down.

Just a minor inconvenience but that would be great and more intuitive if it jumped directly to the warning/error under point in the list.

[minad]

Almost none of the Consult commands works like this except consult-line, which splits the list of candidates and wraps them around. Therefore I don't think we should just add this only for consult-flymake. Now I could imagine some general machinery, where arbitrary candidate lists associated with lines are post-processed and wrapped around at the candidate next to the current line.

Btw, for the error message you could also use the mouse. ;)

[minad]

Flymake installs itself as Eldoc function. This works almost out of the box. Checkout the Eldoc documentation strategy, such that Eldoc shows the messages from all backends.

Thank you for pointing this, I didn't know about that. I tweaked (setopt eldoc-documentation-strategy 'eldoc-documentation-compose) and it shows the Flymake message in the echo area, but with the symbol description at the same time (on 2 lines). I'm trying to have it only show one type at once and with Flymake message in priority but since (add-hook 'eldoc-documentation-functions 'flymake-eldoc-function t t) gets called after (add-hook 'eldoc-documentation-functions #'elisp-eldoc-var-docstring nil t) the latter gets precedence over the former unfortunately.

Yes, the Eldoc default config is not particularly nice. I have it also tweaked to display everything on a single line.

Your function returns Help: #<subr someHash_anonymous_lambda_40> when point is on a flagged warning.

Indeed, sometimes the property is a function. This is better:

  (defun +eldoc-help-echo (report &rest _)
    (when-let ((help (help-at-pt-string)))
      (funcall report (format "Help: %s" help))))

[grolongo]

I have it also tweaked to display everything on a single line.

Do you mind sharing what you did? I'm not sure if you mean displaying both sources (eldoc default source + flymake) on a single line at the same time or alternatively.

[minad]

(setopt eldoc-idle-delay 1
        eldoc-print-after-edit nil
        eldoc-echo-area-display-truncation-message nil
        eldoc-message-function #'+eldoc-message
        eldoc-documentation-strategy #'eldoc-documentation-compose)
(defun +eldoc-message (&rest args)
  (unless (minibufferp)
    (message "%s" (string-replace "\n"
                                  #("   " 1 2 (face (:inverse-video t) display (space :width (1))))
                                  (apply #'format args)))))

[grolongo]

Thanks minad. I finally managed to make it so Flymake messages get priority by moving the function in front. This way I only have one at once:

(setopt eldoc-documentation-strategy 'eldoc-documentation-default)

(add-hook 'eldoc-mode-hook
          (lambda ()
            (setq eldoc-documentation-functions
                  (cons #'flymake-eldoc-function
                        (remove #'flymake-eldoc-function eldoc-documentation-functions)))))

[minad]

Only tangentially related to your Flymake issue - I have proposed the Eldoc function for help-echo upstream: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=77169