This module adds syntax highlighting for various tags in code comments, such as
TODO, FIXME, and NOTE, among others.
- @hlissner
Become a maintainer?
This module has no flags.
- doom-package:hl-todo
No hacks documented for this module.
This module does not have a changelog yet.
Enable this module in your doom! block.
This module has no external requirements.
🔨 This module’s usage documentation is incomplete. Complete it?
By enabling this module, the following keywords will be highlighted if they occur in code comments:
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.
| keybind | description |
|---|---|
| [[kbd:][]t]] | go to next TODO item |
| [[kbd:]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 |
🔨 This module’s configuration documentation is incomplete. Complete it?
To add your own ITEMS you would need to configure them using
hl-todo-keyword-faces:
;; in $DOOMDIR/config.el
(after! hl-todo
(setq hl-todo-keyword-faces
`(("FOO" . ,(face-foreground "MY COLOUR HEX CODE"))
("BAR" . ,(face-foreground 'my-colour-var)))))There are no known problems with this module. Report one?
This module has no FAQs yet. Ask one?
🔨 This module has no appendix yet. Write one?