Consult-org-roam - Completion and preview with consult

Hello everyone,

since I really like consults and its preview feature, I decided to create an extension/adapter for org-roam to use it. Besides adding some convenience methods, like grepping for content with consult-grep (or consult-ripgrep) and searching for roam-files, org-roam's competing-read-functions (org-roam-node-read and org-roam-ref-read) are overridden with equivalent functions using consult--read. For my use cases this works well so far.

The code is hosted here:

What do you think of this approach? Do you have any remarks how to improve it?
Do you see any drawbacks doing it this way?

Best regards,
jgru

5 Likes

Great addition to org-roam. I just posted on the GH repo the suggestion to stick with naming conventions and change the name to consult-org-roam.

1 Like

Thanks for getting back to me and suggesting to change the name.
I changed the repo’s name and the code base to consult-org-roam, so that it’s conforming with consult’s naming scheme.

Best regards,
jgru

Do you guys think that the package is valuable addition and should be put up on Melpa?

Best regards,
jgru

Yes, definitely! :slight_smile:

FYI: I submitted the package to Melpa and wait for review from their side now. For details, see here
Furthermore, I added some features like selectively disabling preview for certain functions.

Best regards,
jgru

2 Likes