feat: support inserting links via Telescope-orgmode

This feature provides a convenient way to create links to existing
org-files and headlines via telescope.

It leverages the already existing search for headlines.

It relies on an extension of the API of nvim-orgmode, which exposes its
existing feature to insert links. The Telescope feature acts as a
drop-in-replacement to create/select the Link target.

Author: Sebastian Flügge

lua/telescope-orgmode/init.lua

@@ -1,4 +1,5 @@
 return {
   refile_heading = require('telescope-orgmode.refile_heading'),
   search_headings = require('telescope-orgmode.search_headings'),
+  insert_link = require('telescope-orgmode.insert_link'),
 }

lua/telescope-orgmode/insert_link.lua

@@ -0,0 +1,60 @@
+local pickers = require('telescope.pickers')
+local finders = require('telescope.finders')
+local conf = require('telescope.config').values
+local action_set = require('telescope.actions.set')
+local actions = require('telescope.actions')
+local action_state = require('telescope.actions.state')
+
+---@type OrgApi
+local OrgApi = require('orgmode.api')
+
+local utils = require('telescope-orgmode.utils')
+
+---@class MatchEntry
+---@field value OrgEntry
+---@field ordinal string
+---@field filename string
+---@field lnum number
+---@field display function
+---@field location string,
+---@field line string,
+
+local function insert(prompt_bufnr)
+  actions.close(prompt_bufnr)
+
+  ---@type MatchEntry
+  local entry = action_state.get_selected_entry()
+
+  -- Link to the filename by default
+  local destination = entry.value.file.filename
+
+  -- Link to a specific heading if is set
+  if entry.value.headline then
+    destination = 'file:' .. entry.value.file.filename .. '::*' .. entry.value.headline.title
+  end
+
+  --print(vim.inspect(destination))
+  OrgApi.insert_link(destination)
+  return true
+end
+
+return function(opts)
+  opts = opts or {}
+
+  pickers
+    .new(opts, {
+      prompt_title = 'Link Target',
+      finder = finders.new_table({
+        results = utils.get_entries(opts),
+        entry_maker = opts.entry_maker or utils.make_entry(opts),
+      }),
+      sorter = conf.generic_sorter(opts),
+      previewer = conf.grep_previewer(opts),
+      attach_mappings = function(prompt_bufnr, map)
+        action_set.select:replace(insert)
+        map('i', '<c-space>', utils.gen_depth_toggle(opts, prompt_bufnr))
+        return true
+      end,
+    })
+    :find()
+end

lua/telescope/_extensions/orgmode/init.lua

@@ -6,5 +6,6 @@ return require('telescope').register_extension({
   exports = {
     search_headings = require('telescope-orgmode').search_headings,
     refile_heading = require('telescope-orgmode').refile_heading,
+    insert_link = require('telescope-orgmode').insert_link,
   },
 })