feat: use custom kinds

Author: sudo-tee

README.md

@@ -236,6 +236,8 @@ require('opencode').setup({
       snacks_layout = nil -- `layout` opts to pass to Snacks.picker.pick({ layout = ... })
     },
     completion = {
+      supports_kind_icons = false, -- set to true if your completion engine supports kind icons (blink does) it will show icons with proper highlight instead of a generic kind icon
+      use_native_completion = false, -- Set to true if you use native nvim completion otherwise it might not auto trigger in the input window.
       file_sources = {
         enabled = true,
         preferred_cli_tool = 'server', -- 'fd','fdfind','rg','git','server' if nil, it will use the best available tool, 'server' uses opencode cli to get file list (works cross platform) and supports folders
@@ -622,6 +624,7 @@ The plugin provides the following actions that can be triggered via keymaps, com
 - `open_input` (boolean, default: `true`): Whether to open the input window after adding the selection. Set to `false` to add selection silently without changing focus.
 
 Example keymap for silent add:
+
 ```lua
 ['<leader>oY'] = { 'add_visual_selection', { open_input = false }, mode = {'v'} }
 ```

ftplugin/opencode.lua

@@ -12,13 +12,15 @@ local bufnr = vim.api.nvim_get_current_buf()
 local opencode_completion_ls = require('opencode.lsp.opencode_completion_ls')
 local client_id = opencode_completion_ls.start(bufnr)
 local completion = require('opencode.ui.completion')
+local config = require('opencode.config')
+local use_native_completion = config.ui.completion.use_native_completion
 
 if client_id then
   -- track insert start state
   vim.api.nvim_create_autocmd('InsertEnter', {
     buffer = bufnr,
     callback = function()
-      if not completion.has_completion_engine() then
+      if use_native_completion then
         vim.lsp.completion.enable(true, client_id, bufnr, { autotrigger = true })
       end
       completion.on_insert_enter()
@@ -32,3 +34,54 @@ if client_id then
     end,
   })
 end
+-- blink.cmp capabilities
+-- completion = {
+--   completionItem = {
+--     commitCharactersSupport = false,
+--     deprecatedSupport = true,
+--     documentationFormat = { "markdown", "plaintext" },
+--     insertReplaceSupport = true,
+--     preselectSupport = false,
+--     resolveSupport = {
+--       properties = { "additionalTextEdits", "command" }
+--     },
+--     snippetSupport = true,
+--     tagSupport = {
+--       valueSet = { 1 }
+--     }
+--   },
+--   completionItemKind = {
+--     valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 }
+--   },
+--   completionList = {
+--     itemDefaults = { "editRange", "insertTextFormat", "insertTextMode", "data" }
+--   },
+--   contextSupport = true,
+--   dynamicRegistration = false
+-- },
+
+-- cmp capabilities
+-- completion = {
+--   completionItem = {
+--     commitCharactersSupport = false,
+--     deprecatedSupport = true,
+--     documentationFormat = { "markdown", "plaintext" },
+--     insertReplaceSupport = true,
+--     preselectSupport = false,
+--     resolveSupport = {
+--       properties = { "additionalTextEdits", "command" }
+--     },
+--     snippetSupport = true,
+--     tagSupport = {
+--       valueSet = { 1 }
+--     }
+--   },
+--   completionItemKind = {
+--     valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 }
+--   },
+--   completionList = {
+--     itemDefaults = { "editRange", "insertTextFormat", "insertTextMode", "data" }
+--   },
+--   contextSupport = true,
+--   dynamicRegistration = false
+-- },

lua/opencode/config.lua

@@ -149,6 +149,8 @@ M.defaults = {
       snacks_layout = nil,
     },
     completion = {
+      supports_kind_icons = false,
+      use_native_completion = false,
       file_sources = {
         enabled = true,
         preferred_cli_tool = 'server',

lua/opencode/lsp/opencode_completion_ls.lua

@@ -1,3 +1,4 @@
+local config = require('opencode.config')
 ---In-process LSP server for opencode completion
 ---Provides completion for files, subagents, commands, and context items
 ---Works with any LSP-compatible completion plugin (blink.cmp, nvim-cmp, etc.)
@@ -60,10 +61,8 @@ local function get_completion_context(params)
   return word, trigger_char, line
 end
 
-local function supports_kind_icons()
-  -- only blink.cmp supports kind icons currently, so we check for its presence
-  local has_blink_cmp = pcall(require, 'blink.cmp')
-  return has_blink_cmp
+function M.supports_kind_icons()
+  return config.ui.completion.supports_kind_icons
 end
 
 ---Convert opencode CompletionItem to LSP CompletionItem
@@ -72,12 +71,11 @@ end
 ---@return lsp.CompletionItem
 local function to_lsp_item(item, index)
   local source = require('opencode.ui.completion').get_source_by_name(item.source_name)
-
   local lsp_item = {
-    label = (supports_kind_icons() and '' or (item.kind_icon .. ' ')) .. item.label,
-    kind = vim.lsp.protocol.CompletionItemKind.Text,
-    kind_icon = supports_kind_icons() and item.kind_icon or nil, -- Only include kind_icon if supported
+    label = (M.supports_kind_icons() and '' or item.kind_icon .. ' ') .. item.label,
+    kind = source.custom_kind or vim.lsp.protocol.CompletionItemKind.Function,
     kind_hl = item.kind_hl,
+    kind_icon = M.supports_kind_icons() and item.kind_icon or '',
     detail = item.detail,
     documentation = item.documentation and {
       kind = 'plaintext',

lua/opencode/types.lua

@@ -107,6 +107,8 @@
 
 ---@class OpencodeCompletionConfig
 ---@field file_sources OpencodeCompletionFileSourcesConfig
+---@field supports_kind_icons boolean
+---@field use_native_completion boolean
 
 ---@class OpencodeLoadingAnimationConfig
 ---@field frames string[]
@@ -196,7 +198,6 @@
 
 ---@class OpencodeConfig
 ---@field preferred_picker 'telescope' | 'fzf' | 'mini.pick' | 'snacks' | 'select' | nil
----@field preferred_completion 'blink' | 'nvim-cmp' | 'vim_complete' | nil -- Preferred completion strategy for mentons and commands
 ---@field default_global_keymaps boolean
 ---@field default_mode 'build' | 'plan' | string -- Default mode
 ---@field default_system_prompt string | nil
@@ -413,6 +414,7 @@
 ---@field on_complete fun(item: CompletionItem): nil Optional callback when item is selected
 ---@field is_incomplete? boolean Whether the completion results are incomplete (for sources that support pagination)
 ---@field get_trigger_character? fun(): string|nil Optional function returning the trigger character for this source
+---@field custom_kind? integer Custom LSP CompletionItemKind registered for this source
 
 ---@class OpencodeContext
 ---@field current_file OpencodeContextFile|nil

lua/opencode/ui/completion.lua

@@ -114,27 +114,4 @@ function M.is_visible()
   return M._pending and next(M._pending) ~= nil
 end
 
-function M.has_completion_engine()
-  local config = require('opencode.config')
-  local preferred = config.preferred_completion or config.preferred_completion_engine
-  if preferred and preferred ~= 'vim_complete' then
-    return true
-  end
-
-  local known_engines = {
-    'cmp',
-    'blink.cmp',
-    'completion',
-    'mini.completion',
-    'minuet',
-  }
-
-  for _, engine in ipairs(known_engines) do
-    if package.loaded[engine] then
-      return true
-    end
-  end
-  return false
-end
-
 return M

lua/opencode/ui/completion/commands.lua

@@ -20,10 +20,13 @@ local get_available_commands = Promise.async(function()
   return results
 end)
 
+local custom_kind = require('opencode.ui.completion.kind')
+
 ---@type CompletionSource
 local command_source = {
   name = 'commands',
   priority = 1,
+  custom_kind = custom_kind.register('commands', require('opencode.ui.icons').get('command')),
   complete = Promise.async(function(context)
     local icons = require('opencode.ui.icons')
     if not context.line:match('^' .. vim.pesc(context.trigger_char) .. '[^%s/]*$') then
@@ -47,7 +50,7 @@ local command_source = {
       if context.input == '' or name_lower:find(input_lower, 1, true) or desc_lower:find(input_lower, 1, true) then
         local item = {
           label = command.name .. (command.args and ' *' or ''),
-          kind = 'command',
+          kind = 'commands',
           kind_icon = icons.get('command'),
           detail = command.description,
           documentation = command.documentation .. (command.args and '\n\n* This command takes arguments.' or ''),

lua/opencode/ui/completion/context.lua

@@ -226,10 +226,13 @@ local function remove_inserted_text(item)
   vim.fn.feedkeys(vim.api.nvim_replace_termcodes('a', true, false, true), 'n')
 end
 
+local custom_kind = require('opencode.ui.completion.kind')
+
 ---@type CompletionSource
 local context_source = {
   name = 'context',
   priority = 1,
+  custom_kind = custom_kind.register('context', icons.get('status_on')),
   complete = Promise.async(function(completion_context)
     local input = completion_context.input or ''
 

lua/opencode/ui/completion/files.lua

@@ -107,11 +107,14 @@ local function create_file_item(file, suffix, priority)
   }
 end
 
+local custom_kind = require('opencode.ui.completion.kind')
+
 ---@type CompletionSource
 local file_source = {
   name = 'files',
   priority = 5,
   is_incomplete = true,
+  custom_kind = custom_kind.register('files', icons.get('file')),
   complete = Promise.async(function(context)
     local sort_util = require('opencode.ui.completion.sort')
     local file_config = config.ui.completion.file_sources

lua/opencode/ui/completion/kind.lua

@@ -0,0 +1,25 @@
+local M = {}
+
+local KIND_OFFSET = 100
+
+---Register a custom LSP CompletionItemKind for a completion source.
+---@param source_name string
+---@param kind_icon? string
+---@return integer custom_kind_id
+function M.register(source_name, kind_icon)
+  local kind_name = 'Opencode' .. (source_name:gsub('^%l', string.upper))
+
+  if not vim.lsp.protocol.CompletionItemKind[kind_name] then
+    local next_id = KIND_OFFSET
+    while vim.lsp.protocol.CompletionItemKind[next_id] do
+      next_id = next_id + 1
+    end
+
+    vim.lsp.protocol.CompletionItemKind[kind_name] = next_id
+    vim.lsp.protocol.CompletionItemKind[next_id] = (kind_icon and kind_icon .. ' ' or '') .. kind_name
+  end
+
+  return vim.lsp.protocol.CompletionItemKind[kind_name]
+end
+
+return M