chore(image-paste): code cleanup and tests

Author: sudo-tee

lua/opencode/context.lua

@@ -66,6 +66,7 @@ function M.is_context_enabled(context_key)
   end
 end
 
+---@return OpencodeDiagnostic[]|nil
 function M.get_diagnostics(buf)
   if not M.is_context_enabled('diagnostics') then
     return nil
@@ -146,11 +147,18 @@ function M.add_file(file)
     return
   end
 
+  if not util.is_path_in_cwd(file) and not util.is_temp_path(file, 'pasted_image') then
+    vim.notify('File not added to context. Must be inside current working directory.')
+    return
+  end
+
   file = vim.fn.fnamemodify(file, ':p')
 
   if not vim.tbl_contains(M.context.mentioned_files, file) then
     table.insert(M.context.mentioned_files, file)
   end
+
+  state.context_updated_at = vim.uv.now()
 end
 
 function M.remove_file(file)
@@ -358,7 +366,7 @@ local function format_selection_part(selection)
   }
 end
 
----@param diagnostics vim.Diagnostic[]
+---@param diagnostics OpencodeDiagnostic[]
 local function format_diagnostics_part(diagnostics)
   local diag_list = {}
   for _, diag in ipairs(diagnostics) do

lua/opencode/image_handler.lua

@@ -1,128 +1,127 @@
+--- Image pasting functionality from clipboard
+--- @see https://github.com/sst/opencode/blob/45180104fe84e2d0b9d29be0f9f8a5e52d18e102/packages/opencode/src/cli/cmd/tui/util/clipboard.ts
 local context = require('opencode.context')
 local state = require('opencode.state')
 
 local M = {}
 
---- Check if a file was successfully created and has content
---- @param path string File path to check
---- @return boolean success True if file exists and has content
+--- Check if a file exists and has content
+--- @param path string
+--- @return boolean
 local function is_valid_file(path)
-  return vim.fn.filereadable(path) == 1 and vim.fn.getfsize(path) > 0
+  return vim.fn.getfsize(path) > 0
 end
 
---- Try to extract image from macOS clipboard
---- @param image_path string Path where to save the image
---- @return boolean success True if image was extracted successfully
-local function try_macos_clipboard(image_path)
-  if vim.fn.executable('osascript') ~= 1 then
-    return false
-  end
-
-  local osascript_cmd = string.format(
-    'osascript -e \'set imageData to the clipboard as "PNGf"\' '
-      .. '-e \'set fileRef to open for access POSIX file "%s" with write permission\' '
-      .. "-e 'set eof fileRef to 0' "
-      .. "-e 'write imageData to fileRef' "
-      .. "-e 'close access fileRef'",
-    image_path
-  )
-
-  local result = vim.system({ 'sh', '-c', osascript_cmd }):wait()
-  return result.code == 0 and is_valid_file(image_path)
+--- Run shell command and return success
+--- @param cmd string
+--- @return boolean
+local function run_shell_cmd(cmd)
+  return vim.system({ 'sh', '-c', cmd }):wait().code == 0
 end
 
---- Try to extract image from Linux clipboard (Wayland)
---- @param image_path string Path where to save the image
---- @return boolean success True if image was extracted successfully
-local function try_wayland_clipboard(image_path)
-  if vim.fn.executable('wl-paste') ~= 1 then
-    return false
+--- Save base64 data to file
+--- @param data string
+--- @param path string
+--- @return boolean
+local function save_base64(data, path)
+  if vim.fn.has('win32') == 1 then
+    local script =
+      string.format('[System.IO.File]::WriteAllBytes("%s", [System.Convert]::FromBase64String("%s"))', path, data)
+    return vim.system({ 'powershell.exe', '-command', '-' }, { stdin = script }):wait().code == 0
+  else
+    local decode_arg = vim.uv.os_uname().sysname == 'Darwin' and '-D' or '-d'
+    return vim.system({ 'sh', '-c', string.format('base64 %s > "%s"', decode_arg, path) }, { stdin = data }):wait().code
+      == 0
   end
-
-  local cmd = string.format('wl-paste -t image/png > "%s"', image_path)
-  local result = vim.system({ 'sh', '-c', cmd }):wait()
-  return result.code == 0 and is_valid_file(image_path)
 end
 
---- Try to extract image from Linux clipboard (X11)
---- @param image_path string Path where to save the image
---- @return boolean success True if image was extracted successfully
-local function try_x11_clipboard(image_path)
-  if vim.fn.executable('xclip') ~= 1 then
+--- macOS clipboard image handler using osascript
+--- @param path string
+--- @return boolean
+local function handle_darwin_clipboard(path)
+  if vim.fn.executable('osascript') ~= 1 then
     return false
   end
+  local cmd = string.format(
+    "osascript -e 'set imageData to the clipboard as \"PNGf\"' -e 'set fileRef to open for access POSIX file \"%s\" with write permission' -e 'set eof fileRef to 0' -e 'write imageData to fileRef' -e 'close access fileRef'",
+    path
+  )
+  return run_shell_cmd(cmd)
+end
 
-  local cmd = string.format('xclip -selection clipboard -t image/png -o > "%s"', image_path)
-  local result = vim.system({ 'sh', '-c', cmd }):wait()
-  return result.code == 0 and is_valid_file(image_path)
+--- Linux clipboard image handler supporting Wayland and X11
+--- @param path string
+--- @return boolean
+local function handle_linux_clipboard(path)
+  if vim.fn.executable('wl-paste') == 1 and run_shell_cmd(string.format('wl-paste -t image/png > "%s"', path)) then
+    return true
+  end
+  return vim.fn.executable('xclip') == 1
+    and run_shell_cmd(string.format('xclip -selection clipboard -t image/png -o > "%s"', path))
 end
 
---- Try to extract image from Windows/WSL clipboard
---- @param image_path string Path where to save the image
---- @return boolean success True if image was extracted successfully
-local function try_windows_clipboard(image_path)
+--- Windows clipboard image handler using PowerShell
+--- @param path string
+--- @return boolean
+local function handle_windows_clipboard(path)
   if vim.fn.executable('powershell.exe') ~= 1 then
     return false
   end
+  local script = string.format(
+    [[
+      Add-Type -AssemblyName System.Windows.Forms;
+      $img = [System.Windows.Forms.Clipboard]::GetImage();
+      if ($img) {
+        $img.Save('%s', [System.Drawing.Imaging.ImageFormat]::Png);
+      } else {
+        exit 1
+      }
+    ]],
+    path
+  )
+  return vim.system({ 'powershell.exe', '-command', '-' }, { stdin = script }):wait().code == 0
+end
 
-  local powershell_script = [[
-    Add-Type -AssemblyName System.Windows.Forms; 
-    $img = [System.Windows.Forms.Clipboard]::GetImage(); 
-    if ($img) { 
-      $ms = New-Object System.IO.MemoryStream; 
-      $img.Save($ms, [System.Drawing.Imaging.ImageFormat]::Png); 
-      [System.Convert]::ToBase64String($ms.ToArray()) 
-    }
-  ]]
-
-  local result = vim.system({ 'powershell.exe', '-command', powershell_script }):wait()
-  if result.code ~= 0 or not result.stdout or result.stdout:gsub('%s', '') == '' then
-    return false
+local handlers = {
+  Darwin = handle_darwin_clipboard,
+  Linux = handle_linux_clipboard,
+  Windows_NT = handle_windows_clipboard,
+}
+
+--- Try to get image from system clipboard
+--- @param image_path string
+--- @return boolean
+local function try_system_clipboard(image_path)
+  local os_name = vim.uv.os_uname().sysname
+  local handler = handlers[os_name]
+
+  -- WSL detection and override
+  if vim.fn.exists('$WSL_DISTRO_NAME') == 1 then
+    handler = handlers.Windows_NT
   end
 
-  local base64_data = result.stdout:gsub('%s', '')
-  local decode_cmd = string.format('echo "%s" | base64 -d > "%s"', base64_data, image_path)
-  local decode_result = vim.system({ 'sh', '-c', decode_cmd }):wait()
-  return decode_result.code == 0 and is_valid_file(image_path)
+  return handler and handler(image_path) and is_valid_file(image_path) or false
 end
 
---- Try to extract image from clipboard as base64 text
---- @param temp_dir string Temporary directory
---- @param timestamp string Timestamp for filename
---- @return string|nil image_path Path to extracted image, or nil if failed
+--- Try to parse base64 image data from clipboard
+--- @param temp_dir string
+--- @param timestamp string
+--- @return boolean, string?
 local function try_base64_clipboard(temp_dir, timestamp)
-  local clipboard_content = vim.fn.getreg('+')
-  if not clipboard_content or not clipboard_content:match('^data:image/[^;]+;base64,') then
-    return nil
+  local content = vim.fn.getreg('+')
+  if not content or content == '' then
+    return false
   end
 
-  local format, base64_data = clipboard_content:match('^data:image/([^;]+);base64,(.+)$')
-  if not format or not base64_data then
-    return nil
+  local format, data = content:match('^data:image/([^;]+);base64,(.+)$')
+  if not format or not data then
+    return false
   end
 
-  local image_path = temp_dir .. '/pasted_image_' .. timestamp .. '.' .. format
-  local decode_cmd = string.format('echo "%s" | base64 -d > "%s"', base64_data, image_path)
-  local result = vim.system({ 'sh', '-c', decode_cmd }):wait()
-
-  if result.code == 0 and is_valid_file(image_path) then
-    return image_path
-  end
-  return nil
-end
+  local image_path = string.format('%s/pasted_image_%s.%s', temp_dir, timestamp, format)
+  local success = save_base64(data, image_path) and is_valid_file(image_path)
 
---- Get error message for missing clipboard tools
---- @param os_name string Operating system name
---- @return string error_message Error message with installation instructions
-local function get_clipboard_error_message(os_name)
-  local install_msg = 'No image found in clipboard. Install clipboard tools: '
-  if os_name == 'Linux' then
-    return install_msg .. 'xclip (X11) or wl-clipboard (Wayland)'
-  elseif os_name == 'Darwin' then
-    return install_msg .. 'system clipboard should work natively'
-  else
-    return install_msg .. 'PowerShell (Windows/WSL)'
-  end
+  return success, success and image_path or nil
 end
 
 --- Handle clipboard image data by saving it to a file and adding it to context
@@ -131,39 +130,27 @@ function M.paste_image_from_clipboard()
   local temp_dir = vim.fn.tempname()
   vim.fn.mkdir(temp_dir, 'p')
   local timestamp = os.date('%Y%m%d_%H%M%S')
-  local image_path = temp_dir .. '/pasted_image_' .. timestamp .. '.png'
+  local image_path = string.format('%s/pasted_image_%s.png', temp_dir, timestamp)
 
-  local os_name = vim.uv.os_uname().sysname
-  local success = false
-
-  if os_name == 'Darwin' then
-    success = try_macos_clipboard(image_path)
-  elseif os_name == 'Windows_NT' or vim.fn.exists('$WSL_DISTRO_NAME') == 1 then
-    success = try_windows_clipboard(image_path)
-  elseif os_name == 'Linux' then
-    success = try_wayland_clipboard(image_path) or try_x11_clipboard(image_path)
-  end
+  local success = try_system_clipboard(image_path)
 
   if not success then
-    local fallback_path = try_base64_clipboard(temp_dir, timestamp)
-    if fallback_path then
-      image_path = fallback_path
-      success = true
+    local base64_success, base64_path = try_base64_clipboard(temp_dir, timestamp --[[@as string]])
+    success = base64_success
+    if base64_path then
+      image_path = base64_path
     end
   end
 
-  if not success then
-    vim.notify(get_clipboard_error_message(os_name), vim.log.levels.WARN)
-    return false
+  if success then
+    context.add_file(image_path)
+    state.context_updated_at = os.time()
+    vim.notify('Image saved and added to context: ' .. vim.fn.fnamemodify(image_path, ':t'), vim.log.levels.INFO)
+    return true
   end
 
-  context.add_file(image_path)
-  state.context_updated_at = os.time()
-
-  local filename = vim.fn.fnamemodify(image_path, ':t')
-  vim.notify(string.format('Image saved and added to context: %s', filename), vim.log.levels.INFO)
-
-  return true
+  vim.notify('No image found in clipboard.', vim.log.levels.WARN)
+  return false
 end
 
 return M

lua/opencode/types.lua

@@ -1,4 +1,15 @@
 
+---@class OpencodeDiagnostic
+---@field message string
+---@field severity number
+---@field lnum number
+---@field col number
+---@field end_lnum? number
+---@field end_col? number
+---@field source? string
+---@field code? string|number
+---@field user_data? any
+
 ---@class OpencodeConfigFile
 ---@field theme string
 ---@field autoshare boolean
@@ -333,7 +344,7 @@
 ---@field mentioned_files string[]|nil
 ---@field mentioned_subagents string[]|nil
 ---@field selections OpencodeContextSelection[]|nil
----@field linter_errors vim.Diagnostic[]|nil
+---@field linter_errors OpencodeDiagnostic[]|nil
 
 ---@class OpencodeContextSelection
 ---@field file OpencodeContextFile

lua/opencode/ui/formatter.lua

@@ -379,7 +379,7 @@ function M._format_diagnostics_context(output, part)
     return
   end
   local start_line = output:get_line_count()
-  local diagnostics = json.content --[[@as vim.Diagnostic[] ]]
+  local diagnostics = json.content --[[@as OpencodeDiagnostic[] ]]
   if not diagnostics or type(diagnostics) ~= 'table' or #diagnostics == 0 then
     return
   end

lua/opencode/util.lua

@@ -382,4 +382,32 @@ function M.pcall_trace(fn, ...)
   end, ...)
 end
 
+function M.is_path_in_cwd(path)
+  local cwd = vim.fn.getcwd()
+  local abs_path = vim.fn.fnamemodify(path, ':p')
+  return abs_path:sub(1, #cwd) == cwd
+end
+
+--- Check if a given path is in the system temporary directory.
+--- Optionally match the filename against a pattern.
+--- @param path string File path to check
+--- @param pattern string|nil Optional Lua pattern to match the filename
+--- @return boolean is_temp
+function M.is_temp_path(path, pattern)
+  local temp_dir = vim.fn.tempname()
+  temp_dir = vim.fn.fnamemodify(temp_dir, ':h')
+
+  local abs_path = vim.fn.fnamemodify(path, ':p')
+  if abs_path:sub(1, #temp_dir) ~= temp_dir then
+    return false
+  end
+
+  if pattern then
+    local filename = vim.fn.fnamemodify(path, ':t')
+    return filename:match(pattern) ~= nil
+  end
+
+  return true
+end
+
 return M

tests/unit/context_spec.lua

@@ -120,8 +120,16 @@ describe('add_file/add_selection/add_subagent', function()
     vim.fn.filereadable = function()
       return 1
     end
+    local util = require('opencode.util')
+    local original_is_path_in_cwd = util.is_path_in_cwd
+    util.is_path_in_cwd = function()
+      return true
+    end
+
     context.add_file('/tmp/foo.lua')
     assert.same({ '/tmp/foo.lua' }, context.context.mentioned_files)
+
+    util.is_path_in_cwd = original_is_path_in_cwd
   end)
   it('does not add file if not filereadable', function()
     vim.fn.filereadable = function()