Insert link from consult-org-headings with embark

consult-org-heading-store-link.el

(defun my/org-link-heading-here (cand)
    (when-let ((marker (get-text-property 0 'consult--candidate cand)))
      (save-excursion
	(with-current-buffer (marker-buffer marker)
	  (goto-char marker)
	  (org-store-link nil t)))
      (org-insert-all-links 1 "" " ")))
(defvar-keymap embark-consult-org-heading-map
  :doc "Keymap for operating on org headings"
  :parent embark-general-map
  "l" 'my/org-link-heading-here)
(add-to-list 'embark-keymap-alist '(consult-org-heading . embark-consult-org-heading-map))
;; make sure it quits to restore point
(setf (alist-get 'my/org-link-heading-here embark-quit-after-action) t)

Made an extension to also support consult-outline. Although outline != org, most of the outline modes I work in happens to be Org mode anyway.

(cl-defun my/org-link-heading-here (cand)
  (when-let ((marker (or (get-text-property 0 'consult--candidate cand)
                         (car (get-text-property 0 'consult-location cand)))))
    (save-excursion
      (goto-char marker)
      (org-store-link nil t))
    (org-insert-all-links 1 "" " ")))

(embark-define-keymap embark-consult-org-heading-map
  "Keymap for operating on org headings"
  ("l" 'my/org-link-heading-here))
(add-to-list 'embark-keymap-alist '(consult-org-heading embark-consult-org-heading-map))

(embark-define-keymap embark-consult-outline-map
  "Keymap for operating on org headings listed by consult-outline"
  ("l" 'my/org-link-heading-here))
(add-to-list 'embark-keymap-alist '(consult-location embark-consult-outline-map))

;; make sure it quits to restore point
(setf (alist-get 'my/org-link-heading-here embark-quit-after-action) t)

Good idea. Does org-store-link know how to deal with outline headings (separate from org headings)?

No, org-store-link is outline unaware, and outline-mode is unaware of storing links. I just happened to have a shortcut for outline instead of consult-org-heading.

Recently, embark has removed embark-define-keymap; updated.

The parentheses around ("l" 'my/org-link-heading-here) should be removed.

Yep, thanks.

BTW, have you tried consult-org-agenda? Basically it's consult-org-heading across all agenda files. A little slow for giant files but pretty good. I updated the function to correctly handle adding an :ID: and linking to other files.

No I didn't, mostly because I use a single Org file per context. But good to know nevertheless.