Search and jump hl-todo keywords in buffers with consult.

• consult-todo
  • Screenshot
  • Install
    • dependencies
    • package
  • Usage
  • Customization
  • Todo
  • License

• consult-todo: Jump to hl-todo keywords in current buffer.

• consult-todo-all: Jump to hl-todo keywords in all live buffers.

• Emacs, version >= 29.1
• hl-todo
• consult

• Manually

Clone and add to load-path, require the package.

• Melpa

Install with M-x package-install RET consult-todo within Emacs.

;; Directly
(require 'consult-todo)

;; Or with use-package
(use-package consult-todo :demand t)

• consult-todo: search in current buffer

• consult-todo-all: search in all hl-todo-mode enabled buffers

• consult-todo-dir: search in selected directory

• consult-todo-project: search in current project

• consult-todo-narrow: Mapping of narrows and keywords, if it's nil, use default value below instead.

(defconst consult-todo--narrow
  '((?t . "TODO")
    (?f . "FIXME")
    (?b . "BUG")
    (?h . "HACK"))
  "Default mapping of narrow and keywords.")

• consult-todo-other: Cons for other missing keywords, (?. . "OTHER") by default.

• consult-todo-only-comment: Toggle whether only search keywords in comment, only effective on buffers

• consult-todo-cache-threshold: Time threshold in seconds for using cache when greping is time-consuming

• search keywords in all project files

See LICENSE.