feat(hyperlinks): Add OSC 8 hyperlink support

Author: kristijanhusak

lua/orgmode/colors/highlighter/markup/link.lua

@@ -1,13 +1,16 @@
 local ts_utils = require('orgmode.utils.treesitter')
+local utils = require('orgmode.utils')
 
 ---@class OrgLinkHighlighter : OrgMarkupHighlighter
 ---@field private markup OrgMarkupHighlighter
+---@field private has_extmark_url_support boolean
 local OrgLink = {}
 
 ---@param opts { markup: OrgMarkupHighlighter }
 function OrgLink:new(opts)
   local data = {
     markup = opts.markup,
+    has_extmark_url_support = vim.fn.has('nvim-0.10.2') == 1,
   }
   setmetatable(data, self)
   self.__index = self
@@ -100,12 +103,18 @@ function OrgLink:highlight(highlights, bufnr)
     local alias = link:find('%]%[') or 1
     local link_end = link:find('%]%[') or (link:len() - 1)
 
-    vim.api.nvim_buf_set_extmark(bufnr, namespace, entry.from.line, entry.from.start_col, {
+    local link_opts = {
       ephemeral = ephemeral,
       end_col = entry.to.end_col,
       hl_group = '@org.hyperlink',
       priority = 110,
-    })
+    }
+
+    if self.has_extmark_url_support then
+      link_opts.url = alias > 1 and link:sub(3, alias - 1) or link:sub(3, -3)
+    end
+
+    vim.api.nvim_buf_set_extmark(bufnr, namespace, entry.from.line, entry.from.start_col, link_opts)
 
     vim.api.nvim_buf_set_extmark(bufnr, namespace, entry.from.line, entry.from.start_col, {
       ephemeral = ephemeral,

tests/plenary/colors/highlighter_spec.lua

@@ -5,6 +5,8 @@ local api = vim.api
 
 describe('highlighter', function()
   local ns_id = api.nvim_create_namespace('org_custom_highlighter')
+  local has_extmarks_url_support = vim.fn.has('nvim-0.10.2') == 1
+
   local get_extmarks = function(content)
     ---@diagnostic disable-next-line: inject-field
     config.ts_hl_enabled = true
@@ -33,6 +35,9 @@ describe('highlighter', function()
     if opts.spell ~= nil then
       assert.are.same(opts.spell, details.spell, 'spell is not matching')
     end
+    if has_extmarks_url_support and opts.url ~= nil then
+      assert.are.same(opts.url, details.url, 'url is not matching')
+    end
   end
 
   after_each(function()
@@ -209,7 +214,10 @@ describe('highlighter', function()
         'I have [[https://google.com]] link',
       })
       assert.are.same(4, #extmarks)
-      assert_extmark(extmarks[1], { line = 0, start_col = 7, end_col = 29, hl_group = '@org.hyperlink' })
+      assert_extmark(
+        extmarks[1],
+        { line = 0, start_col = 7, end_col = 29, hl_group = '@org.hyperlink', url = 'https://google.com' }
+      )
       assert_extmark(extmarks[2], { line = 0, start_col = 7, end_col = 9, conceal = '' })
       assert_extmark(extmarks[3], { line = 0, start_col = 9, end_col = 27, spell = false })
       assert_extmark(extmarks[4], { line = 0, start_col = 27, end_col = 29, conceal = '' })
@@ -220,7 +228,10 @@ describe('highlighter', function()
         'I have [[https://google.com][google]] link',
       })
       assert.are.same(4, #extmarks)
-      assert_extmark(extmarks[1], { line = 0, start_col = 7, end_col = 37, hl_group = '@org.hyperlink' })
+      assert_extmark(
+        extmarks[1],
+        { line = 0, start_col = 7, end_col = 37, hl_group = '@org.hyperlink', url = 'https://google.com' }
+      )
       assert_extmark(extmarks[2], { line = 0, start_col = 7, end_col = 29, conceal = '' })
       assert_extmark(extmarks[3], { line = 0, start_col = 9, end_col = 27, spell = false })
       assert_extmark(extmarks[4], { line = 0, start_col = 35, end_col = 37, conceal = '' })
@@ -231,7 +242,10 @@ describe('highlighter', function()
         'I have [[https://google.com][google I am *not bold*]] link',
       })
       assert.are.same(4, #extmarks)
-      assert_extmark(extmarks[1], { line = 0, start_col = 7, end_col = 53, hl_group = '@org.hyperlink' })
+      assert_extmark(
+        extmarks[1],
+        { line = 0, start_col = 7, end_col = 53, hl_group = '@org.hyperlink', url = 'https://google.com' }
+      )
       assert_extmark(extmarks[2], { line = 0, start_col = 7, end_col = 29, conceal = '' })
       assert_extmark(extmarks[3], { line = 0, start_col = 9, end_col = 27, spell = false })
       assert_extmark(extmarks[4], { line = 0, start_col = 51, end_col = 53, conceal = '' })