Function: hl-todo-rgrep

hl-todo-rgrep is an interactive and natively compiled function defined in hl-todo.el.

Signature

(hl-todo-rgrep REGEXP &optional FILES DIR CONFIRM)

Documentation

Use rgrep to find all TODO or similar keywords.

This actually finds a superset of the highlighted keywords, because it uses a regexp instead of a more sophisticated matcher. It also finds occurrences that are not within a string or comment. See rgrep for the meaning of REGEXP, FILES, DIR and CONFIRM, except that the type of prefix argument does not matter; with any prefix you can edit the constructed shell command line before it is executed. Also see option hl-todo-keyword-faces.

Key Bindings

This command is not in any keymaps.

Source Code

;; Defined in /nix/store/b97f5zr6snxdbh1bgqmj50mq949vd13i-emacs-packages-deps/share/emacs/site-lisp/elpa/hl-todo-20261001.1547/hl-todo.el
;;;###autoload
(defun hl-todo-rgrep (regexp &optional files dir confirm)
  "Use `rgrep' to find all TODO or similar keywords.
This actually finds a superset of the highlighted keywords,
because it uses a regexp instead of a more sophisticated
matcher.  It also finds occurrences that are not within a
string or comment.  See `rgrep' for the meaning of REGEXP,
FILES, DIR and CONFIRM, except that the type of prefix
argument does not matter; with any prefix you can edit the
constructed shell command line before it is executed.
Also see option `hl-todo-keyword-faces'."
  (interactive
    (progn
      (require 'grep)
      (grep-compute-defaults)
      (unless grep-find-template
        (error "grep.el: No `grep-find-template' available"))
      (let ((regexp (with-temp-buffer (hl-todo--regexp t))))
        (list regexp
              (grep-read-files regexp)
              (read-directory-name "Base directory: " nil default-directory t)
              current-prefix-arg))))
  (rgrep regexp files dir confirm))