awesome-emacs/doomemacs
1
0
Fork 0
mirror of https://github.com/doomemacs/doomemacs synced 2025-08-01 12:17:25 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
388f59d9e0d1dafd0339069c67f0f48beb1be6c2
doomemacs/modules/ui/hl-todo
History
Henrik Lissner 2bc67d8387 bump: :app :checkers :config :emacs :term :tools :ui 
Alexander-Miller/treemacs@a6f9e9f1ce -> Alexander-Miller/treemacs@63e2bc207a
Silex/docker.el@9bcefbe54d -> Silex/docker.el@4fc69969b1
akermu/emacs-libvterm@2b1392cb2b -> akermu/emacs-libvterm@2681120b77
bdarcus/bibtex-actions@6e3a194c3a -> bdarcus/bibtex-actions@08c6ca0e5b
dash-docs-el/dash-docs@dafc8fc9f1 -> dash-docs-el/dash-docs@29848b6b34
dgutov/diff-hl@992559f98a -> dgutov/diff-hl@40c89a7b0d
dimitri/switch-window@2801d9b3a9 -> dimitri/switch-window@8d9fe251d8
editorconfig/editorconfig-emacs@e10fa22b13 -> editorconfig/editorconfig-emacs@2ab86dc9a8
ema2159/centaur-tabs@9c7c936e4e -> ema2159/centaur-tabs@8b4249c405
emacs-circe/circe@d6f1fa1864 -> emacs-circe/circe@77e16de3b9
emacs-lsp/lsp-treemacs@905cc74726 -> emacs-lsp/lsp-treemacs@d82df44d63
emacsorphanage/osx-trash@0f1dc052d0 -> emacsorphanage/osx-trash@af74a2055a
emacsorphanage/quickrun@35e91f4b6c -> emacsorphanage/quickrun@78317951cd
flycheck/flycheck@21d52264aa -> flycheck/flycheck@784f184cdd
hlissner/emacs-doom-themes@9e2680b918 -> hlissner/emacs-doom-themes@65fb964f36
https://git.savannah.gnu.org/git/emms.git@6e0aaaf4c559 -> https://git.savannah.gnu.org/git/emms.git@c42fab572846
ideasman42/emacs-spell-fu@1abcb5594e -> ideasman42/emacs-spell-fu@10823ae58f
ideasman42/emacs-undo-fu@e0ad06b5ef -> ideasman42/emacs-undo-fu@34b27c01da
joostkremers/writeroom-mode@b648b34017 -> joostkremers/writeroom-mode@7f4ec92404
kidd/org-gcal.el@4c2616a4f8 -> kidd/org-gcal.el@80e6f9501f
magnars/expand-region.el@4b8322774d -> magnars/expand-region.el@95a773bd8f
millejoh/emacs-ipython-notebook@09af85821e -> millejoh/emacs-ipython-notebook@0600c286bd
mohkale/consult-eglot@a6aeb6fa07 -> mohkale/consult-eglot@28a09cc839
noctuid/link-hint.el@09ba5727d8 -> noctuid/link-hint.el@d3c5bacc9c
rolandwalker/nav-flash@55786c9582 -> rolandwalker/nav-flash@2e31f32085
skeeto/elfeed@243add9e74 -> skeeto/elfeed@162d7d545e
szermatt/emacs-bash-completion@65e54c6f9c -> szermatt/emacs-bash-completion@c5eaeed156
tarsius/hl-todo@5ac0076cfe -> tarsius/hl-todo@42f744ffb5
tecosaur/emacs-everywhere@64ba2e3f30 -> tecosaur/emacs-everywhere@da88fa2d04
tkf/emacs-request@f3a5b4352e -> tkf/emacs-request@2b68b3ca54
tmalsburg/helm-bibtex@a0d32ab167 -> tmalsburg/helm-bibtex@b85662081d
yoshiki/yaml-mode@3a57058468 -> yoshiki/yaml-mode@63b637f846
yqrashawn/fd-dired@c223aee30a -> yqrashawn/fd-dired@458464771b
2021-09-15 17:47:17 +02:00
..
config.el
refactor: rename orig-fn arg in advice to fn
2021-08-04 01:53:12 -04:00
packages.el
bump: :app :checkers :config :emacs :term :tools :ui
2021-09-15 17:47:17 +02:00
README.org
Fix broken link
2020-09-09 17:14:53 +02:00

README.org

:ui hl-todo

Description

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

Module Flags

This module provides no flags

Plugins

Prerequisites

This module has no prerequisites

Features

Making Items

You can make a TODO item by simply writing

  • 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 Adding items.

The way you would add a TODO item is to use a snippet but these have not been made. you can make them yourself by adding the snippet to $DOOMDIR/snippets/MAJOR-MODE/name-of-snippet. you will find more info on how to make them here

Configuration

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

;; the default
(after! hl-todo
  (setq hl-todo-keyword-faces
        `(
          ("FOO"  . ,(face-foreground "MY COLOUR HEX CODE"))
          ("BAR" . ,(face-foreground 'my-colour-var)))))

TODO Troubleshooting

If you have any problems with this module do get in touch!