feat(completion): better sorting for context items

Author: sudo-tee

lua/opencode/types.lua

@@ -303,6 +303,7 @@
 ---@field documentation string Documentation text
 ---@field insert_text string Text to insert when selected
 ---@field source_name string Name of the completion source
+---@field priority? number Optional priority for individual item sorting (lower numbers have higher priority)
 ---@field data table Additional data associated with the item
 
 ---@class CompletionSource

lua/opencode/ui/completion/context.lua

@@ -4,6 +4,11 @@ local state = require('opencode.state')
 local icons = require('opencode.ui.icons')
 
 local M = {}
+local kind_priority = {
+  selection_item = 3,
+  mentioned_file = 4,
+  subagent = 5,
+}
 
 ---@generic T
 ---@param name string
@@ -13,7 +18,7 @@ local M = {}
 ---@param icon string|nil
 ---@param additional_data? T
 ---@return CompletionItem
-local function create_context_item(name, type, available, documentation, icon, additional_data)
+local function create_context_item(name, type, available, documentation, icon, additional_data, priority)
   local label = name
 
   return {
@@ -24,6 +29,7 @@ local function create_context_item(name, type, available, documentation, icon, a
     documentation = documentation or (available and name or 'Enable ' .. name .. ' for this message'),
     insert_text = '',
     source_name = 'context',
+    priority = priority or (available and 100 or 200),
     data = { type = type, name = name, available = available, additional_data = additional_data },
   }
 end
@@ -100,7 +106,15 @@ local function add_mentioned_files_items(ctx)
       local filename = vim.fn.fnamemodify(file, ':~:.')
       table.insert(
         items,
-        create_context_item(filename, 'mentioned_file', true, 'Select to remove file ' .. filename, icons.get('file'))
+        create_context_item(
+          filename,
+          'mentioned_file',
+          true,
+          'Select to remove file ' .. filename,
+          icons.get('file'),
+          nil,
+          kind_priority.mentioned_file
+        )
       )
     end
   end
@@ -125,7 +139,15 @@ local function add_selection_items(ctx)
       string.format('Selection %d %s (%s)', i, selection.file and selection.file.name or 'Untitled', selection.lines)
     table.insert(
       items,
-      create_context_item(label, 'selection_item', true, format_selection(selection), icons.get('selection'), selection)
+      create_context_item(
+        label,
+        'selection_item',
+        true,
+        format_selection(selection),
+        icons.get('selection'),
+        selection,
+        kind_priority.selection_item
+      )
     )
   end
   return items
@@ -141,7 +163,15 @@ local function add_subagents_items(ctx)
   for _, agent in ipairs(ctx.mentioned_subagents or {}) do
     table.insert(
       items,
-      create_context_item(agent .. ' (agent)', 'subagent', true, 'Select to remove agent ' .. agent, icons.get('agent'))
+      create_context_item(
+        agent .. ' (agent)',
+        'subagent',
+        true,
+        'Select to remove agent ' .. agent,
+        icons.get('agent'),
+        nil,
+        kind_priority.subagent
+      )
     )
   end
   return items
@@ -198,13 +228,6 @@ local context_source = {
       end, items)
     end
 
-    table.sort(items, function(a, b)
-      if a.data.available ~= b.data.available then
-        return a.data.available
-      end
-      return a.label < b.label
-    end)
-
     return items
   end,
   on_complete = function(item)

lua/opencode/ui/completion/engines/blink_cmp.lua

@@ -64,8 +64,15 @@ function Source:get_completions(ctx, callback)
         detail = item.detail,
         documentation = item.documentation,
         insertText = item.insert_text or item.label,
-        sortText = string.format('%02d_%02d_%s', completion_source.priority or 999, i, item.label),
-        score_offset = -(completion_source.priority or 999) * 1000,
+        sortText = string.format(
+          '%02d_%02d_%02d_%s',
+          completion_source.priority or 999,
+          item.priority or 999,
+          i,
+          item.label
+        ),
+        score_offset = -(completion_source.priority or 999) * 1000 + (item.priority or 999),
+
         data = {
           original_item = item,
         },

lua/opencode/ui/completion/engines/nvim_cmp.lua

@@ -62,7 +62,7 @@ function M.setup(completion_sources)
           detail = item.detail,
           documentation = item.documentation,
           insertText = item.insert_text or item.label,
-          sortText = string.format('%02d_%02d_%s', completion_source.priority or 999, j, item.label),
+          sortText = string.format('%02d_%02d_%02d_%s', completion_source.priority or 999, item.priority or 999, j, item.label),
           data = {
             original_item = item,
           },

lua/opencode/ui/completion/engines/vim_complete.lua

@@ -87,20 +87,27 @@ function M._update()
   local items = {}
   for _, source in ipairs(M._completion_sources or {}) do
     local source_items = source.complete(context)
-    for _, item in ipairs(source_items) do
+    for i, item in ipairs(source_items) do
       if vim.startswith(item.insert_text or '', trigger_char) then
         item.insert_text = item.insert_text:sub(2)
       end
+      local source_priority = source.priority or 999
+      local item_priority = item.priority or 999
       table.insert(items, {
         word = #item.insert_text > 0 and item.insert_text or item.label,
         abbr = (item.kind_icon or '') .. item.label,
         menu = source.name,
         kind = item.kind:sub(1, 1):upper(),
         user_data = item,
+        _sort_text = string.format('%02d_%02d_%02d_%s', source_priority, item_priority, i, item.label),
       })
     end
   end
 
+  table.sort(items, function(a, b)
+    return a._sort_text < b._sort_text
+  end)
+
   if #items > 0 then
     local start_col = before_cursor:find(vim.pesc(trigger_char) .. '[%w_%-%.]*$')
     if start_col then

lua/opencode/ui/completion/files.lua

@@ -79,7 +79,7 @@ end
 
 ---@param file string
 ---@return CompletionItem
-local function create_file_item(file, suffix)
+local function create_file_item(file, suffix, priority)
   local filename = vim.fn.fnamemodify(file, ':t')
   local dir = vim.fn.fnamemodify(file, ':h')
   local file_path = dir == '.' and filename or dir .. '/' .. filename
@@ -101,6 +101,7 @@ local function create_file_item(file, suffix)
     documentation = 'Path: ' .. detail,
     insert_text = file_path,
     source_name = 'files',
+    priority = priority,
     data = { name = filename, full_path = full_path },
   }
 end
@@ -126,7 +127,7 @@ local file_source = {
     end
 
     local files_and_dirs = find_files_fast(input)
-    local items = vim.tbl_map(create_file_item, files_and_dirs)
+    local items = vim.tbl_map(function(file) return create_file_item(file, nil, 10) end, files_and_dirs)
     sort_util.sort_by_relevance(items, input, function(item)
       return vim.fn.fnamemodify(item.label, ':t')
     end, function(a, b)
@@ -155,7 +156,7 @@ function M.get_recent_files()
   if result then
     for _, file in ipairs(result) do
       local suffix = table.concat({ file.added and '+' .. file.added, file.removed and '-' .. file.removed }, ' ')
-      table.insert(recent_files, create_file_item(file.path, ' ' .. suffix))
+      table.insert(recent_files, create_file_item(file.path, ' ' .. suffix, 1))
     end
   end
   return recent_files