Acces Ruff documentation from Flymake diags buffer

[sonofjon]

Would you be interested in adding this type of funtionality?

;; Open Ruff docs from Flymake
(defun aj8/flymake-ruff-goto-doc ()
"Open the documentation for the Ruff rule on a Flymake diagnostic line.

Scan the Flymake diagnostic at point for a “[F821]”-style code
and browse to its anchor at https://docs.astral.sh/ruff/rules."
(interactive)
  (unless (derived-mode-p 'flymake-diagnostics-buffer-mode)
    (user-error "Not in a Flymake diagnostics buffer"))
  (let* ((id (tabulated-list-get-id))
         (diag (or (plist-get id :diagnostic)
                   (user-error "Bad Flymake ID: %S" id)))
         (msg (flymake-diagnostic-text diag)))
    (unless (string-match (rx "[" (group (1+ upper-case) (1+ digit)) "]")
                          msg)
      (user-error "No Ruff rule (like [F821]) in diagnostic: %s" msg))
    (browse-url
     (format "https://docs.astral.sh/ruff/rules#%s"
             (match-string 1 msg)))))

(with-eval-after-load 'flymake
  (define-key flymake-diagnostics-buffer-mode-map (kbd "M-RET")
    #'aj8/flymake-ruff-goto-doc))

[erickgnavar]

Hi, it would be a nice to have, just some ideas of improvements:

• Use https://docs.astral.sh/ruff/rules/%s instead of https://docs.astral.sh/ruff/rules#%s, so we go directly to the detail page of the error
• In recent versiones of ruff the error code it's not wrapped into [] so the regex won't match, I had to change that to make it work
• this should be a separate function that it documented in the README and with a section where we put a code to added to flymake-diagnostics-buffe, it should not be added by default, the user would evaluate if they want it

It's a great idea, if you willing to do the PR I'll merge it

[sonofjon]

Okay, I will submit a PR. However, I cannot reproduce the missing square brackets in recent ruff versions. I am using the latest from GitHub, version 0.11.12, and error codes are warapped in [] for me. Which version are you using?

[sonofjon]

I've sent the PR, adressing bullets 1 and 3 for now.

[erickgnavar]

Okay, I will submit a PR. However, I cannot reproduce the missing square brackets in recent ruff versions. I am using the latest from GitHub, version 0.11.12, and error codes are warapped in [] for me. Which version are you using?

Hi, sorry for the late response, I just test it again and it's not working for me, I'm using 0.12.2 version, here is an screenshot of the errors

[sonofjon]

Very strange. I am now also on 0.12.2, but still get the brackets. Not sure how to investigate this further.

[erickgnavar]

Very strange. I am now also on 0.12.2, but still get the brackets. Not sure how to investigate this further.

Do you have any special configuration for ruff? Maybe can you send a few sample files and the exact command that ruff is using so we can compare it in the terminal