emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/hl-todo
History
Henrik Lissner 1c4217aa27
refactor: minor refactors & commentary revision 
* lisp/doom-cli.el:
  - reference backport source commit.
  - doom-cli--restart: a type check is all we need here. This is a
    programmer error, not a user error.
* lisp/doom-editor.el (recentf): mention recentf-show-abbreviated (added in
  emacs-mirror/emacs@32906819ad)
* lisp/doom-keybinds.el (doom-init-leader-keys-h): move to
  doom-after-init-hook, in case the user customizes leader variables in
  a previous hook (like emacs-startup-hook or after-init-hook).
* lisp/doom-start.el: use eval-when! to compile out the section on
  non-macOS systems (when Doom gets around to compiling its core files,
  later).
* modules/config/literate/autoload.el (+literate-config-file): use
  file-name-concat instead of string concat. This relaxes the
  requirement that doom-user-dir end in a /; a requirement I intend to
  fully phase out.
* modules/lang/emacs-lisp/autoload.el (+emacs-lisp-non-package): remove
  empty map! macro in flycheck-emacs-lisp-check-form. The macro already
  no-ops at compile-time/in noninteractive sessions since b480ed51a3.
* modules/ui/hl-todo/config.el (hl-todo-keyword-faces): revise
  commentary for default hl-todo keywords.

Ref: emacs-mirror/emacs@32906819ad
Ref: b480ed51a3
2022-09-24 20:31:34 +02:00
..
config.el refactor: minor refactors & commentary revision 2022-09-24 20:31:34 +02:00
packages.el bump: :ui 2022-03-31 21:08:31 +02:00
README.org revert: fix(docs): set mode in file-local vars 2022-08-07 19:08:07 +02:00

README.org

:ui hl-todo

Description   unfold

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

Maintainers

Become a maintainer?

Module flags

This module has no flags.

Packages

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

🔨 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.

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

TODO Configuration

🔨 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)))))

Troubleshooting

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

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?