:ui hl-todo

Highlight TODO/FIXME/NOTE/DEPRECATED/HACK/REVIEW

1. Description

This module adds syntax highlighting for TODO/FIXME/NOTE tags in programming major-modes.

1.1. Maintainers

This module has no dedicated maintainers. Become a maintainer?

1.2. Module flags

This module has no flags.

1.4. Hacks

No hacks documented for this module.

2. Prerequisites

This module has no external prerequisites.

3. Usage

You can create a TODO by using any of the following in a commented line:

  • TODO: For things that need to be done, just not today.
  • HACK: For tidbits that are unconventional and not intended uses of the constituent parts, and may break in a future update.
  • FIXME: For problems that will become bigger problems later if not fixed ASAP.
  • REVIEW: for things that were done hastily and/or hasn’t been thoroughly tested. it may not even be necessary!
  • NOTE: For especially important gotchas with a given implementation, directed at another user other than the author.
  • DEPRECATED: For things that just gotta go and will soon be gone.
  • BUG: For a known bug that needs a workaround
  • XXX: For warning about a problematic or misguiding code

3.1. Keybindings

keybind description
]t go to next TODO item
[t go to previous TODO item
SPC p t show all TODO items in a project
SPC s p search project for a string
SPC s b search buffer for string

4. Configuration

To add your own ITEMS you would need to configure them using hl-todo-keyword-faces:

# ⎘
(after! hl-todo
  (setq hl-todo-keyword-faces
	`(("FOO" . "#ff0000")
	  ("BAR" . ,(face-foreground 'font-lock-comment-face)))))

5. TODO Troubleshooting

There are no known problems with this module. Report one?

6. TODO Appendix

This module has no appendix yet. Write one?