Is it possible to enable breadcrumbs during consult preview?

[amosbird]

This feature would be useful for navigating large codebases by showing which method a previewed line belongs to. Currently, the preview buffer does not display breadcrumbs. Should I add a hook to enable it?

[minad]

I believe consult-preview-allowed-hooks should be able to handle this. See the examples at https://github.com/minad/consult?tab=readme-ov-file#live-previews.

(add-to-list 'consult-preview-allowed-hooks 'breadcrumb-local-mode)

[amosbird]

I tried the following:

(add-to-list 'consult-preview-allowed-hooks 'prog-mode)
(add-to-list 'consult-preview-allowed-hooks 'c++-ts-mode)
(add-to-list 'consult-preview-allowed-hooks 'breadcrumb-local-mode)

However, it still doesn't work.

[minad]

Well, trying blindly doesn't usually lead to a working result (what are prog-mode and c++-ts-mode doing there?). Did you take a look at the documentation and the examples? breadcrumb-local-mode seems to be the one you want to allow. But note that you also have to add breadcrumb-local-mode to the respective major mode hook in the first place to enable it.

[amosbird]

Well, trying blindly doesn't usually lead to a working result

Yes.

After examining how consult-preview works, it turns out I need to do the following:

(setq consult-preview-variables (assq-delete-all 'delay-mode-hooks consult-preview-variables))

[minad]

No, this is not the right thing. If you disable delay-mode-hooks, all hooks will be enabled during preview, which is usually not desired. Consult provides consult-preview-allowed-hooks specifically in order to run certain hooks despite delay-mode-hooks=t:

consult/consult.el

Lines 1341 to 1346 in 41d382c

	;; Run delayed hooks listed in `consult-preview-allowed-hooks'.
	(dolist (hook (reverse (cons 'after-change-major-mode-hook delayed-mode-hooks)))
	(run-hook-wrapped hook (lambda (fun)
	(when (consult--preview-allowed-p fun)
	(funcall fun))
	nil)))

[amosbird]

Oops, I should have realized earlier that Doom Emacs doesn't have a recent enough version of the Consult package. I don't have the changes from this commit, which means consult-preview-allowed-hooks only handles find-file-hook.

Thanks for helping me out!