https://github.com/tarsius/hl-todo

Highlight TODO keywords
https://github.com/tarsius/hl-todo

Last synced: 30 days ago
JSON representation

Highlight TODO keywords

• Host: GitHub
• URL: https://github.com/tarsius/hl-todo
• Owner: tarsius
• License: gpl-3.0
• Created: 2013-03-10T21:34:21.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T15:39:01.000Z (7 months ago)
• Last Synced: 2024-05-02T00:20:41.658Z (7 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 143 KB
• Stars: 406
• Watchers: 10
• Forks: 26
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
** Highlight TODO and similar keywords in comments and strings

To highlight keywords turn on ~hl-todo-mode~ in individual buffers

or use the global variant ~global-hl-todo-mode~.

You can customize the keywords that are recognized by customizing

~hl-todo-keyword-faces~ either through the customization interface

or by setting the variable directly in your init file, for example:

#+begin_src emacs-lisp

  (setq hl-todo-keyword-faces

        '(("TODO"   . "#FF0000")

          ("FIXME"  . "#FF0000")

          ("DEBUG"  . "#A020F0")

          ("GOTCHA" . "#FF4500")

          ("STUB"   . "#1E90FF")))

#+end_src

This package also provides commands for moving to the next or

previous keyword, to invoke ~occur~ with a regexp that matches all

known keywords, and to insert a keyword.  If you want to use these

commands, then you should bind them in ~hl-todo-mode-map~, e.g.:

#+begin_src emacs-lisp

  (keymap-set hl-todo-mode-map "C-c p" #'hl-todo-previous)

  (keymap-set hl-todo-mode-map "C-c n" #'hl-todo-next)

  (keymap-set hl-todo-mode-map "C-c o" #'hl-todo-occur)

  (keymap-set hl-todo-mode-map "C-c i" #'hl-todo-insert)

#+end_src

*** FAQ and Common Issues

See [[https://github.com/tarsius/hl-todo/wiki][FAQ and Common Issues]] if something isn't working as expected.

*** Integrations

- Command ~hl-todo-occur~ uses ~occur~ to list TODO keywords.

- Command ~hl-todo-rgrep~ uses ~rgrep~ to list TODO keywords.

- Function ~hl-todo-flymake~ teaches [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Flymake.html][flymake]] about TODO keywords.

- Package [[https://github.com/alvarogonzalezsotillo/flycheck-hl-todo][flycheck-hl-todo]] adds TODO keywords to [[https://github.com/flycheck/flycheck][flycheck]].

- Package [[https://github.com/alphapapa/magit-todos][magit-todos]] displays TODO keyboards in [[https://github.com/magit/magit][magit]]'s status buffer.

- Package [[https://github.com/liuyinz/consult-todo][consult-todo]] supports searching and jumping to TODO keywords

  using [[https://github.com/minad/consult][consult]].

#+html: 



#+html: 

#+html: 

#+html: