Function: projectile-todos

projectile-todos is an autoloaded, interactive and byte-compiled function defined in projectile.el.

Signature

(projectile-todos &optional ARG)

Documentation

Collect the project's TODO-style annotations and review them read-only.

Searches every project file for the annotation keywords in projectile-todo-keywords (TODO, FIXME, HACK, ... - customize the list to match your own conventions) and gathers the hits into the same read-only *projectile-search* buffer projectile-search-review uses, grouped by file, so all of its navigation, filtering, re-search, export and hand-off commands apply.

A keyword only counts when it stands as a whole word followed by a colon,
by whitespace or by the end of the line, so TODO: and FIXME are
found while TODOS and MASTODON are not. Matching is case-sensitive
(annotation keywords are uppercase by convention); toggle that with c
in the results buffer. The keyword does not have to sit in a comment.

With a prefix argument ARG, prompt for which keywords to search for instead of using all of them.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/projectile-20260820.1509/projectile.el
;;;###autoload
(defun projectile-todos (&optional arg)
  "Collect the project's TODO-style annotations and review them read-only.

Searches every project file for the annotation keywords in
`projectile-todo-keywords' (`TODO', `FIXME', `HACK', ... - customize the
list to match your own conventions) and gathers the hits into the same
read-only `*projectile-search*' buffer `projectile-search-review' uses,
grouped by file, so all of its navigation, filtering, re-search, export
and hand-off commands apply.

A keyword only counts when it stands as a whole word followed by a colon,
by whitespace or by the end of the line, so `TODO:' and `FIXME ' are
found while `TODOS' and `MASTODON' are not.  Matching is case-sensitive
\(annotation keywords are uppercase by convention); toggle that with `c'
in the results buffer.  The keyword does not have to sit in a comment.

With a prefix argument ARG, prompt for which keywords to search for
instead of using all of them."
  (interactive "P")
  (projectile--todos (list (projectile-acquire-root)) arg))