doomemacs/modules/ui/hl-todo/README.org

#+title:    :ui hl-todo
#+subtitle: TODO FIXME NOTE DEPRECATED HACK REVIEW
#+created:  February 19, 2017
#+since:    1.3

* Description :unfold:
This module adds syntax highlighting for various tags in code comments, such as
=TODO=, =FIXME=, and =NOTE=, among others.

** Maintainers
- [[doom-user:][@hlissner]]

[[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:hl-todo]]
 
** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

/This module has no external requirements./

* TODO Usage
#+begin_quote
 🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote

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.

** Keybindings
| keybind | description                      |
|---------+----------------------------------|
| [[kbd:][]t]]      | go to next TODO item             |
| [[kbd:][[t]]      | go to previous TODO item         |
| [[kbd:][SPC p t]] | show all TODO items in a project |
| [[kbd:][SPC s p]] | search project for a string      |
| [[kbd:][SPC s b]] | search buffer for string         |

* TODO Configuration
#+begin_quote
 🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote

To add your own ITEMS you would need to configure them using
~hl-todo-keyword-faces~:
#+begin_src emacs-lisp
;; 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)))))
#+end_src

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote