feat(links): Add links position when using get_links()

Author: kristijanhusak

lua/orgmode/files/elements/range.lua

@@ -5,7 +5,7 @@
 ---@field end_col number
 local Range = {}
 
----@param data table
+---@param data { start_line?: number, end_line?: number, start_col?: number, end_col?: number }
 function Range:new(data)
   local opts = {}
   opts.start_line = data.start_line

lua/orgmode/files/file.lua

@@ -606,8 +606,13 @@ function OrgFile:get_links()
   ]])
 
   local links = {}
+  local processed_lines = {}
   for _, match in ts_query:iter_captures(self.root, self:_get_source()) do
-    vim.list_extend(links, Link.all_from_line(self:get_node_text(match)))
+    local line = match:start()
+    if not processed_lines[line] then
+      vim.list_extend(links, Link.all_from_line(self.lines[line + 1], line + 1))
+      processed_lines[line] = true
+    end
   end
   return links
 end

lua/orgmode/org/hyperlinks/link.lua

@@ -1,19 +1,23 @@
 local Url = require('orgmode.org.hyperlinks.url')
+local Range = require('orgmode.files.elements.range')
 
 ---@class OrgLink
 ---@field url OrgUrl
 ---@field desc string | nil
+---@field range? OrgRange
 local Link = {}
 
 local pattern = '%[%[([^%]]+.-)%]%]'
 
 ---@param str string
+---@param range? OrgRange
 ---@return OrgLink
-function Link:new(str)
+function Link:new(str, range)
   local this = setmetatable({}, { __index = Link })
   local parts = vim.split(str, '][', { plain = true })
   this.url = Url:new(parts[1] or '')
   this.desc = parts[2]
+  this.range = range
   return this
 end
 
@@ -50,13 +54,16 @@ function Link.at_pos(line, pos)
   return Link:new(found_link), position
 end
 
-function Link.all_from_line(line)
+function Link.all_from_line(line, line_number)
   local links = {}
   for link in line:gmatch(pattern) do
     local start_from = #links > 0 and links[#links].to or nil
     local from, to = line:find(pattern, start_from)
     if from and to then
-      table.insert(links, Link:new(link))
+      local range = Range.from_line(line_number)
+      range.start_col = from
+      range.end_col = to
+      table.insert(links, Link:new(link, range))
     end
   end
 

tests/plenary/files/file_spec.lua

@@ -1,5 +1,6 @@
 local OrgFile = require('orgmode.files.file')
 local config = require('orgmode.config')
+local Range = require('orgmode.files.elements.range')
 
 describe('OrgFile', function()
   ---@return OrgFile
@@ -748,23 +749,59 @@ describe('OrgFile', function()
         '  - list item link to [[https://duckduckgo.com][duck]]',
         '',
         '  :LOGBOOK:',
-        '  :TEST: And link in drawer [[https://github.com][github]]',
+        '  :TEST: And link in drawer [[https://github.com][github link]]',
         '  :END:',
       })
       local links = file:get_links()
 
       assert.are.same(4, #links)
       assert.are.same('https://google.com', links[1].url:to_string())
+      assert.are.same(
+        Range:new({
+          start_line = 1,
+          end_line = 1,
+          start_col = 11,
+          end_col = 32,
+        }),
+        links[1].range
+      )
       assert.is.Nil(links[1].desc)
 
       assert.are.same('./some-file.org', links[2].url:to_string())
       assert.is.Nil(links[2].desc)
+      assert.are.same(
+        Range:new({
+          start_line = 3,
+          end_line = 3,
+          start_col = 30,
+          end_col = 48,
+        }),
+        links[2].range
+      )
 
       assert.are.same('https://duckduckgo.com', links[3].url:to_string())
       assert.are.same('duck', links[3].desc)
+      assert.are.same(
+        Range:new({
+          start_line = 4,
+          end_line = 4,
+          start_col = 23,
+          end_col = 54,
+        }),
+        links[3].range
+      )
 
       assert.are.same('https://github.com', links[4].url:to_string())
-      assert.are.same('github', links[4].desc)
+      assert.are.same('github link', links[4].desc)
+      assert.are.same(
+        Range:new({
+          start_line = 7,
+          end_line = 7,
+          start_col = 29,
+          end_col = 63,
+        }),
+        links[4].range
+      )
     end)
 
     it('should get file level property', function()