refactor: move link insertion into Hyperlinks

To have clean module dependencies, insert_link is now a method of
Hyperlinks and is exposed over the api but also called from mappings.

Author: Sebastian Flügge

lua/orgmode/api/init.lua

@@ -10,10 +10,6 @@ local orgmode = require('orgmode')
 ---@field destination OrgApiFile | OrgApiHeadline
 
 ---@class OrgApi
----@field load fun(name?: string|string[]): OrgApiFile|OrgApiFile[]
----@field current fun(): OrgApiFile
----@field refile fun(opts: OrgApiRefileOpts)
----@field insert_link fun(link_location: string): boolean
 local OrgApi = {}
 
 ---@param name? string|string[] specific file names to return (absolute path). If ommitted, returns all loaded files
@@ -109,50 +105,7 @@ end
 --- @param link_location string
 --- @return boolean
 function OrgApi.insert_link(link_location)
-  local selected_link = Link:new(link_location)
-  local desc = selected_link.url:get_target_value()
-  if selected_link.url:is_id() then
-    local id_link = ('id:%s'):format(selected_link.url:get_id())
-    desc = link_location:gsub('^' .. vim.pesc(id_link) .. '%s+', '')
-    link_location = id_link
-  end
-
-  local link_description = vim.trim(vim.fn.OrgmodeInput('Description: ', desc or ''))
-
-  link_location = '[' .. vim.trim(link_location) .. ']'
-
-  if link_description ~= '' then
-    link_description = '[' .. link_description .. ']'
-  end
-
-  local insert_from
-  local insert_to
-  local target_col = #link_location + #link_description + 2
-
-  -- check if currently on link
-  local link, position = Hyperlinks.get_link_under_cursor()
-  if link and position then
-    insert_from = position.from - 1
-    insert_to = position.to + 1
-    target_col = target_col + position.from
-  else
-    local colnr = vim.fn.col('.')
-    insert_from = colnr
-    insert_to = colnr + 1
-    target_col = target_col + colnr
-  end
-
-  local linenr = vim.fn.line('.') or 0
-  local curr_line = vim.fn.getline(linenr)
-  local new_line = string.sub(curr_line, 0, insert_from)
-    .. '['
-    .. link_location
-    .. link_description
-    .. ']'
-    .. string.sub(curr_line, insert_to, #curr_line)
-
-  vim.fn.setline(linenr, new_line)
-  vim.fn.cursor(linenr, target_col)
+  Hyperlinks.insert_link(link_location)
 end
 
 return OrgApi

lua/orgmode/org/hyperlinks/init.lua

@@ -205,12 +205,59 @@ function Hyperlinks.autocomplete_links(arg_lead)
 
   return vim.tbl_keys(Hyperlinks.stored_links)
 end
---
+
 ---@return OrgLink|nil, table | nil
 function Hyperlinks.get_link_under_cursor()
   local line = vim.fn.getline('.')
   local col = vim.fn.col('.') or 0
   return Link.at_pos(line, col)
 end
 
+function Hyperlinks.insert_link(link_location)
+  local selected_link = Link:new(link_location)
+  local desc = selected_link.url:get_target_value()
+  if selected_link.url:is_id() then
+    local id_link = ('id:%s'):format(selected_link.url:get_id())
+    desc = link_location:gsub('^' .. vim.pesc(id_link) .. '%s+', '')
+    link_location = id_link
+  end
+
+  local link_description = vim.trim(vim.fn.OrgmodeInput('Description: ', desc or ''))
+
+  link_location = '[' .. vim.trim(link_location) .. ']'
+
+  if link_description ~= '' then
+    link_description = '[' .. link_description .. ']'
+  end
+
+  local insert_from
+  local insert_to
+  local target_col = #link_location + #link_description + 2
+
+  -- check if currently on link
+  local link, position = Hyperlinks.get_link_under_cursor()
+  if link and position then
+    insert_from = position.from - 1
+    insert_to = position.to + 1
+    target_col = target_col + position.from
+  else
+    local colnr = vim.fn.col('.')
+    insert_from = colnr
+    insert_to = colnr + 1
+    target_col = target_col + colnr
+  end
+
+  local linenr = vim.fn.line('.') or 0
+  local curr_line = vim.fn.getline(linenr)
+  local new_line = string.sub(curr_line, 0, insert_from)
+    .. '['
+    .. link_location
+    .. link_description
+    .. ']'
+    .. string.sub(curr_line, insert_to, #curr_line)
+
+  vim.fn.setline(linenr, new_line)
+  vim.fn.cursor(linenr, target_col)
+end
+
 return Hyperlinks

lua/orgmode/org/mappings.lua

@@ -737,7 +737,7 @@ function OrgMappings:insert_link()
     return
   end
 
-  OrgApi.insert_link(link_location)
+  Hyperlinks.insert_link(link_location)
 end
 
 function OrgMappings:store_link()