Allow flymake-type for each hl-todo keywords

[DevelopmentCool2449]

This idea is for allow each hl-todo keyword have it's own customization with flymake backend.
I was able to do a small functional implementation as show in this screenshot:

However, I have not found a way to make a cleaner implementation for this.

I leave here the code of the implementation that I made, in case there is interest in this:

(defun my/hl-todo-icons (string)
    (setq string (string-remove-suffix ":" string))
    (pcase string
      ("TODO" (intern-soft (concat "hl-todo-flymake-" string)))
      ("BUG" (intern-soft (concat "hl-todo-flymake-" string)))
      ("WARNING" (intern-soft (concat "hl-todo-flymake-" string)))
      ("FIXME" (intern-soft (concat "hl-todo-flymake-" string)))
      (_ 'hl-todo-flymake)))

  (defun my/hl-todo-flymake (report-fn &rest _plist)
    "Flymake backend for `hl-todo-mode'.
Diagnostics are reported to REPORT-FN.  Use `add-hook' to
register this function in `flymake-diagnostic-functions' before
enabling `flymake-mode'."
    (let ((diags nil)
          (buf (current-buffer))
          (comment (concat (regexp-quote comment-start) "\\s-+")))
      (when hl-todo-mode
        (save-excursion
          (save-restriction
            (save-match-data
              (goto-char (point-min))
              (while (hl-todo--search)
                (let ((beg (match-beginning 0))
                      (end (pos-eol))
                      (bol (pos-bol))
                      (type (my/hl-todo-icons (match-string-no-properties 0))))
                  ;; Take whole line when keyword is not at the start of comment.
                  (save-excursion
                    (goto-char beg)
                    (unless (looking-back comment bol)
                      (goto-char bol)
                      ;; Skip whitespace at the beginning of line.
                      (when (and (not (looking-at-p "\\S-"))
                                 (re-search-forward "\\S-" beg t))
                        (forward-char -1))
                      ;; Skip comment.
                      (re-search-forward comment beg t)
                      (setq beg (point))))
                  (push (flymake-make-diagnostic
                         buf beg end type
                         (buffer-substring-no-properties beg end))
                        diags)))))))
      (funcall report-fn (nreverse diags))))

  (put 'hl-todo-flymake-TODO 'flymake-type-name " TODO")
  (put 'hl-todo-flymake-TODO 'flymake-margin-string ; <- ignore this
       (alist-get 'hl-todo-flymake-TODO flymake-margin-indicators-string))
  (put 'hl-todo-flymake-TODO 'flymake-category 'flymake-note)
  (put 'hl-todo-flymake-TODO 'face nil)
  (put 'hl-todo-flymake-TODO 'mode-line-face 'nerd-icons-blue)

  (put 'hl-todo-flymake-BUG 'flymake-type-name " BUG")
  (put 'hl-todo-flymake-BUG 'flymake-margin-string ; <- ignore this
       (alist-get 'hl-todo-flymake-BUG flymake-margin-indicators-string))
  (put 'hl-todo-flymake-BUG 'flymake-category 'flymake-note)
  (put 'hl-todo-flymake-BUG 'face nil)
  (put 'hl-todo-flymake-BUG 'mode-line-face 'compilation-error)

  (put 'hl-todo-flymake-WARNING 'flymake-type-name " WARNING")
  (put 'hl-todo-flymake-WARNING 'flymake-margin-string ; <- ignore this
       (alist-get 'hl-todo-flymake-WARNING flymake-margin-indicators-string))
  (put 'hl-todo-flymake-WARNING 'flymake-category 'flymake-note)
  (put 'hl-todo-flymake-WARNING 'face nil)
  (put 'hl-todo-flymake-WARNING 'mode-line-face 'compilation-warning)

  (put 'hl-todo-flymake-FIXME 'flymake-type-name " FIXME")
  (put 'hl-todo-flymake-FIXME 'flymake-margin-string ; <- ignore this
       (alist-get 'hl-todo-flymake-FIXME flymake-margin-indicators-string))
  (put 'hl-todo-flymake-FIXME 'flymake-category 'flymake-note)
  (put 'hl-todo-flymake-FIXME 'face nil)
  (put 'hl-todo-flymake-FIXME 'mode-line-face 'compilation-error)

[tarsius]

Yeah I briefly considered something like that too, but consider that beyond the scope of this package.

magit-todos is an alternative approach some might find useful.

[DevelopmentCool2449]

The intention was to pass that as an argument.

Yes, I think I know what you mean.

This is my code now:

(defun my/hl-todo-types-icons (locus beg end text)
    (save-match-data
      (string-match hl-todo--regexp text)
      (let ((keyword (string-remove-suffix ":" (match-string 0 text)))
            type)
        (pcase keyword
          ("TODO" (setq type (intern-soft (concat "hl-todo-flymake-" keyword))))
          ("BUG" (setq type (intern-soft (concat "hl-todo-flymake-" keyword))))
          ("WARNING" (setq type (intern-soft (concat "hl-todo-flymake-" keyword))))
          ("FIXME" (setq type (intern-soft (concat "hl-todo-flymake-" keyword))))
          (_ (setq type 'hl-todo-flymake)))
        (flymake-make-diagnostic locus beg end type text))))

(advice-add 'hl-todo-make-flymake-diagnostic :override #'my/hl-todo-types-icons)

The problem is that I have to match again the string to get the keyword

(defun my/hl-todo-types-icons (locus beg end text)
    (save-match-data
      (string-match hl-todo--regexp text)
        ...

because this line is overwriting it

Try the version in the try branch. I'll push it to main once you have confirmed that it works.

I don't understand what you mean, I don't see that try branch.

[tarsius]

I don't understand what you mean, I don't see that try branch.

Doh! Forgot to push.

[DevelopmentCool2449]

Try the version in the try branch. I'll push it to main once you have confirmed that it works.

It now works fine, thank you very much.

[tarsius]

It's in main now.
Goes to double check... yes it is. 😀

[DevelopmentCool2449]

It's in main now. Goes to double check... yes it is. 😀

Thanks, I added a wiki entry on how to add this feature.