feat(agenda): Allow opening links from agenda headlines

Author: kristijanhusak

lua/orgmode/agenda/init.lua

@@ -8,16 +8,18 @@ local Menu = require('orgmode.ui.menu')
 local Promise = require('orgmode.utils.promise')
 local AgendaTypes = require('orgmode.agenda.types')
 local Input = require('orgmode.ui.input')
+local OrgHyperlink = require('orgmode.org.links.hyperlink')
 
 ---@class OrgAgenda
 ---@field highlights table[]
 ---@field views OrgAgendaViewType[]
 ---@field filters OrgAgendaFilter
 ---@field files OrgFiles
 ---@field highlighter OrgHighlighter
+---@field links OrgLinks
 local Agenda = {}
 
----@param opts? { highlighter: OrgHighlighter, files: OrgFiles }
+---@param opts? { highlighter: OrgHighlighter, files: OrgFiles, links: OrgLinks }
 ---@return OrgAgenda
 function Agenda:new(opts)
   opts = opts or {}
@@ -28,6 +30,7 @@ function Agenda:new(opts)
     highlights = {},
     files = opts.files,
     highlighter = opts.highlighter,
+    links = opts.links
   }
   setmetatable(data, self)
   self.__index = self
@@ -619,6 +622,16 @@ function Agenda:get_headline_at_cursor()
   end
 end
 
+function Agenda:open_at_point()
+  local link = OrgHyperlink.from_current_line_position()
+
+  if link then
+    return self.links:follow(link.url:to_string())
+  end
+
+  utils.echo_error('No link found under cursor')
+end
+
 function Agenda:quit()
   vim.api.nvim_win_close(0, true)
 end

lua/orgmode/config/_meta.lua

@@ -83,6 +83,7 @@
 ---@field org_agenda_filter? OrgMappingValue Default: '/'
 ---@field org_agenda_refile? OrgMappingValue Default: '<prefix>r'
 ---@field org_agenda_add_note? OrgMappingValue Default: '<prefix>na'
+---@field org_agenda_open_at_point? OrgMappingValue Default: '<prefix>o'
 ---@field org_agenda_show_help? OrgMappingValue Default: 'g?'
 ---
 ---@class OrgMappingsCapture

lua/orgmode/config/defaults.lua

@@ -108,6 +108,7 @@ local DefaultConfig = {
       org_agenda_goto_date = 'J',
       org_agenda_redo = 'r',
       org_agenda_todo = 't',
+      org_agenda_open_at_point = '<prefix>o',
       org_agenda_clock_goto = '<prefix>xj',
       org_agenda_set_effort = '<prefix>xe',
       org_agenda_clock_in = 'I',

lua/orgmode/config/mappings/init.lua

@@ -117,6 +117,10 @@ return {
         help_desc = 'Open prompt that allows filtering by category, tags and title(vim regex)',
       },
     }),
+    org_agenda_open_at_point = m.action(
+      'agenda.open_at_point',
+      { opts = { desc = 'org open', help_desc = 'Open hyperlink under cursor' } }
+    ),
     org_agenda_refile = m.action('agenda.refile', {
       opts = {
         desc = 'org refile',

lua/orgmode/init.lua

@@ -61,6 +61,7 @@ function Org:init()
   self.agenda = require('orgmode.agenda'):new({
     files = self.files,
     highlighter = self.highlighter,
+    links = self.links,
   })
   self.capture = require('orgmode.capture'):new({
     files = self.files,

lua/orgmode/org/links/hyperlink.lua

@@ -20,6 +20,41 @@ function OrgHyperlink:new(str, range)
   return this
 end
 
+---Get hyperlink under current cursor position by parsing the line
+---@return OrgHyperlink | nil
+function OrgHyperlink.from_current_line_position()
+  local pos = vim.fn.getpos('.')
+  local line = vim.api.nvim_get_current_line()
+  local start_pos = 0
+  local end_pos = 0
+  for i = pos[3], 1, -1 do
+    if line:sub(i, i) == '[' and line:sub(i - 1, i - 1) == '[' then
+      start_pos = i - 1
+      break
+    end
+  end
+  for i = pos[3], #line do
+    if line:sub(i, i) == ']' and line:sub(i + 1, i + 1) == ']' then
+      end_pos = i + 1
+      break
+    end
+  end
+
+  if start_pos == 0 or end_pos == 0 then
+    return nil
+  end
+  local str = line:sub(start_pos + 2, end_pos - 2)
+  return OrgHyperlink:new(
+    str,
+    Range:new({
+      start_line = pos[2],
+      start_col = start_pos,
+      end_line = pos[2],
+      end_col = end_pos,
+    })
+  )
+end
+
 ---@param node TSNode
 ---@param source number | string
 ---@return OrgHyperlink
@@ -33,6 +68,7 @@ function OrgHyperlink.from_node(node, source)
   return this
 end
 
+---Get hyperlink under current cursor position by parsing the treesitter node
 ---@return OrgHyperlink | nil
 function OrgHyperlink.at_cursor()
   local link_node = ts_utils.closest_node(ts_utils.get_node(), { 'link', 'link_desc' })