feat: adds code reference picker to navigate file:line references in LLM responses

aweis89 · aweis89 · commit 7daa6ef553f4 · 2025-12-20T21:34:21.000-08:00
diff --git a/lua/opencode/api.lua b/lua/opencode/api.lua
@@ -307,6 +307,10 @@ function M.focus_input()
   ui.focus_input({ restore_position = true, start_insert = true })
 end
 
+function M.references()
+  require('opencode.ui.reference_picker').pick()
+end
+
 function M.debug_output()
   if not config.debug.enabled then
     vim.notify('Debugging is not enabled in the config', vim.log.levels.WARN)
@@ -1214,6 +1218,10 @@ M.commands = {
     desc = 'Paste image from clipboard and add to context',
     fn = M.paste_image,
   },
+  references = {
+    desc = 'Browse code references from conversation',
+    fn = M.references,
+  },
 }
 
 M.slash_commands_map = {
@@ -1231,6 +1239,7 @@ M.slash_commands_map = {
   ['/sessions'] = { fn = M.select_session, desc = 'Select session' },
   ['/share'] = { fn = M.share, desc = 'Share current session' },
   ['/timeline'] = { fn = M.timeline, desc = 'Open timeline picker' },
+  ['/references'] = { fn = M.references, desc = 'Browse code references from conversation' },
   ['/undo'] = { fn = M.undo, desc = 'Undo last action' },
   ['/unshare'] = { fn = M.unshare, desc = 'Unshare current session' },
   ['/rename'] = { fn = M.rename_session, desc = 'Rename current session' },
diff --git a/lua/opencode/config.lua b/lua/opencode/config.lua
@@ -49,6 +49,7 @@ M.defaults = {
       ['[['] = { 'prev_message' },
       ['<tab>'] = { 'toggle_pane', mode = { 'n', 'i' } },
       ['i'] = { 'focus_input' },
+      ['gr'] = { 'references', desc = 'Browse code references' },
       ['<leader>oS'] = { 'select_child_session' },
       ['<leader>oD'] = { 'debug_message' },
       ['<leader>oO'] = { 'debug_output' },
diff --git a/lua/opencode/types.lua b/lua/opencode/types.lua
@@ -483,3 +483,12 @@
 ---@field messages number Number of messages reverted
 ---@field tool_calls number Number of tool calls reverted
 ---@field files table<string, {additions: number, deletions: number}> Summary of file changes reverted
+
+---@class CodeReference
+---@field file_path string Relative or absolute file path
+---@field line number|nil Line number (1-indexed)
+---@field column number|nil Column number (optional)
+---@field context string Surrounding text for display in picker
+---@field message_id string ID of the message containing this reference
+---@field match_start number Start position of match in original text
+---@field match_end number End position of match in original text
diff --git a/lua/opencode/ui/base_picker.lua b/lua/opencode/ui/base_picker.lua
@@ -17,6 +17,7 @@ local Promise = require('opencode.promise')
 ---@field title string|fun(): string The picker title
 ---@field width? number Optional width for the picker (defaults to config or current window width)
 ---@field multi_selection? table<string, boolean> Actions that support multi-selection
+---@field preview? "file"|"none"|false Preview mode: "file" for file preview, "none" or false to disable
 
 ---@class TelescopeEntry
 ---@field value any
@@ -341,15 +342,23 @@ end
 local function snacks_picker_ui(opts)
   local Snacks = require('snacks')
 
+  -- Determine if preview is enabled
+  local has_preview = opts.preview == 'file'
+
+  -- Choose layout preset based on preview
+  local layout_preset = has_preview and 'default' or 'select'
+
   local snack_opts = {
     title = opts.title,
     layout = {
-      preset = 'select',
+      preset = layout_preset,
       config = function(layout)
         local width = opts.width and (opts.width + 3) or nil -- extra space for snacks UI
-        layout.layout.width = width
-        layout.layout.max_width = width
-        layout.layout.min_width = width
+        if not has_preview then
+          layout.layout.width = width
+          layout.layout.max_width = width
+          layout.layout.min_width = width
+        end
         return layout
       end,
     },
@@ -378,6 +387,11 @@ local function snacks_picker_ui(opts)
     },
   }
 
+  -- Add file preview if enabled
+  if has_preview then
+    snack_opts.preview = 'file'
+  end
+
   snack_opts.win = snack_opts.win or {}
   snack_opts.win.input = snack_opts.win.input or { keys = {} }
 
diff --git a/lua/opencode/ui/formatter.lua b/lua/opencode/ui/formatter.lua
@@ -426,8 +426,63 @@ end
 ---@param output Output Output object to write to
 ---@param text string
 function M._format_assistant_message(output, text)
-  -- output:add_empty_line()
-  output:add_lines(vim.split(text, '\n'))
+  local reference_picker = require('opencode.ui.reference_picker')
+  local references = reference_picker.get_references_for_text(text)
+
+  -- If no references, just add the text as-is
+  if #references == 0 then
+    output:add_lines(vim.split(text, '\n'))
+    return
+  end
+
+  -- Sort references by match_start position (ascending)
+  table.sort(references, function(a, b)
+    return a.match_start < b.match_start
+  end)
+
+  -- Build a new text with icons inserted before each reference
+  local result = ''
+  local last_pos = 1
+  local ref_icon = icons.get('reference')
+
+  for _, ref in ipairs(references) do
+    -- Add text before this reference
+    result = result .. text:sub(last_pos, ref.match_start - 1)
+    -- Add the icon and the reference
+    result = result .. ref_icon .. text:sub(ref.match_start, ref.match_end)
+    last_pos = ref.match_end + 1
+  end
+
+  -- Add any remaining text after the last reference
+  if last_pos <= #text then
+    result = result .. text:sub(last_pos)
+  end
+
+  local lines = vim.split(result, '\n')
+  local start_line = output:get_line_count()
+  output:add_lines(lines)
+
+  -- Add highlighting for reference icons
+  -- We need to find the icon positions in the rendered lines and add extmarks
+  for i, line in ipairs(lines) do
+    local line_num = start_line + i - 1
+    local search_start = 1
+    while true do
+      local icon_start, icon_end = line:find(ref_icon, search_start, true)
+      if not icon_start then
+        break
+      end
+      -- Add extmark for the reference icon
+      output:add_extmark(line_num, {
+        virt_text = { { ref_icon, 'OpencodeReference' } },
+        virt_text_pos = 'overlay',
+        end_col = icon_end,
+        hl_group = 'OpencodeReference',
+        priority = 100,
+      } --[[@as OutputExtmark]])
+      search_start = icon_end + 1
+    end
+  end
 end
 
 ---@param output Output Output object to write to
diff --git a/lua/opencode/ui/highlight.lua b/lua/opencode/ui/highlight.lua
@@ -34,6 +34,7 @@ function M.setup()
     vim.api.nvim_set_hl(0, 'OpencodeContextSwitchOn', { link = '@label', default = true })
     vim.api.nvim_set_hl(0, 'OpencodePickerTime', { link = 'Comment', default = true })
     vim.api.nvim_set_hl(0, 'OpencodeDebugText', { link = 'Comment', default = true })
+    vim.api.nvim_set_hl(0, 'OpencodeReference', { fg = '#1976D2', default = true })
   else
     vim.api.nvim_set_hl(0, 'OpencodeBorder', { fg = '#616161', default = true })
     vim.api.nvim_set_hl(0, 'OpencodeBackground', { link = 'Normal', default = true })
@@ -64,6 +65,7 @@ function M.setup()
     vim.api.nvim_set_hl(0, 'OpencodeContextSwitchOn', { link = '@label', default = true })
     vim.api.nvim_set_hl(0, 'OpencodePickerTime', { link = 'Comment', default = true })
     vim.api.nvim_set_hl(0, 'OpencodeDebugText', { link = 'Comment', default = true })
+    vim.api.nvim_set_hl(0, 'OpencodeReference', { fg = '#7AA2F7', default = true })
   end
 end
 
diff --git a/lua/opencode/ui/icons.lua b/lua/opencode/ui/icons.lua
@@ -25,6 +25,7 @@ local presets = {
     folder = ' ',
     attached_file = '󰌷 ',
     agent = '󰚩 ',
+    reference = ' ',
     -- statuses
     status_on = ' ',
     status_off = ' ',
@@ -60,6 +61,7 @@ local presets = {
     folder = '[@]',
     attached_file = '@',
     agent = '@',
+    reference = '@',
     -- statuses
     status_on = 'ON',
     status_off = 'OFF',
diff --git a/lua/opencode/ui/reference_picker.lua b/lua/opencode/ui/reference_picker.lua
