How to customize hl-todo highlighted keywords

[sfavazza]

Description :octocat:

I was trying to add few keywords to the hl-todo-keyword-faces without success.

Reproduction guide :beetle:

• add the following snippet to your .spacemacs in the dotspacemacs/user-config

  (with-eval-after-load 'hl-todo
  (setq hl-todo-keyword-faces
        '(("TODO" . "#dc752f")
          ("NEXT" . "#dc752f")
          ("THEM" . "#2d9574")
          ("PROG" . "#4f97d7")
          ("OKAY" . "#4f97d7")
          ("DONT" . "#f2241f")
          ("FAIL" . "#f2241f")
          ("DONE" . "#86dc2f")
          ("NOTE" . "#b1951d")
          ("KLUDGE" . "#b1951d")
          ("HACK" . "#b1951d")
          ("TEMP" . "#b1951d")
          ("FIXME" . "#dc752f")
          ("XXX+" . "#dc752f")
          ("IMPORTANT" . "#b1951d")
          ("WARNING:" . "#dc752f")
          ("\\?\\?\\?+" . "#dc752f"))))

• Start Emacs

Observed behaviour: :eyes: :broken_heart: Nothing change, the highlighting remains unchanged.

Expected behaviour: :heart: :smile: The highlighting of the additional words should reflect the given configuration.

System Info :computer:

• OS: gnu/linux
• Emacs: 29.1
• Spacemacs: 0.999.0
• Spacemacs branch: develop (rev. b86a07443)
• Graphic display: t
• Running in daemon: mars
• Distribution: spacemacs
• Editing style: hybrid
• Completion: helm
• Layers:

  ((auto-completion :variables auto-completion-tab-key-behavior 'cycle auto-completion-enable-snippets-in-popup t auto-completion-idle-delay 0.0 auto-completion-minimum-prefix-length 1 auto-completion-enable-help-tooltip 'manual auto-completion-private-snippets-directory "~/snippets" company-show-quick-access 'left company-selection-wrap-around t)
  bm
  (c-c++ :variables c-c++-adopt-subprojects t c-c++-backend 'lsp-clangd c-c++-lsp-enable-semantic-highlight 'rainbow)
  (cmake :variables cmake-enable-cmake-ide-support t)
  cscope csv
  (dap :variables dap-auto-configure-features
    '(tooltip)
    dap-python-debugger 'debugpy)
  (docker :variables docker-container-shell-file-name "/bin/bash" docker-compose-command "docker compose" docker-tramp-use-names t docker-dockerfile-backend 'lsp)
  emacs-lisp eww git go graphviz
  (helm :variables helm-no-header nil helm-position 'top)
  html javascript
  (lsp :variables lsp-enable-indentation nil lsp-navigation 'peek lsp-ui-remap-xref-keybindings t lsp-ui-doc-include-signature t lsp-lens-enable t lsp-headerline-breadcrumb-segments
    '(project file symbols)
    lsp-warn-no-matched-clients nil lsp-clients-clangd-args
    '("--header-insertion=never"))
  lua
  (markdown :variables markdown-live-preview-engine 'vmd)
  multiple-cursors org
  (python :variables python-fill-column 112)
  (ranger :variables ranger-enter-with-minus nil ranger-override-dired t ranger-cleanup-on-disable nil ranger-show-hidden t ranger-parent-depth 1 ranger-show-literal nil)
  rust semantic
  (shell :variables shell-default-height 30 shell-default-position 'bottom shell-default-shell 'multi-vterm shell-default-term-shell "/bin/bash" multi-term-program "/bin/bash" shell-enable-smart-eshell t)
  shell-scripts
  (spacemacs-language :variables google-translate-default-target-language "en")
  (spell-checking :variables enable-flyspell-auto-completion nil ispell-dictionary "en_US" ispell-program-name "hunspell")
  systemd yaml vue)

• System configuration features: ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM HARFBUZZ JPEG JSON LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NATIVE_COMP NOTIFY INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF TOOLKIT_SCROLL_BARS TREE_SITTER WEBP X11 XAW3D XDBE XIM XINPUT2 XPM LUCID ZLIB

[sfavazza]

After some debugging and testing the following solution worked for me:

(add-hook 'spacemacs-post-theme-change-hook
          (lambda ()
            (mapc (lambda (hl-tuple) (add-to-list 'hl-todo-keyword-faces
                                                  hl-tuple))
                  '(("WARNING" . "#b1951d")
                    ("IMPORTANT" . "#f2241f")))))

The failure of the first snippet of code was due to the fact that:

• hl-todo-keyword-faces is customized when loading the spacemacs theme
• the theme is loaded after the user configuration (discovered with printf-debugging style)
• hence the first snippet effect was overloaded