feat(ui): add opt.kind to vim.ui.select (neovim#15838)

Co-authored-by: Justin M. Keyes <[email protected]>
Aetf · Nov 1, 2021 · 7ae86c1 · 7ae86c1
1 parent a68faed
commit 7ae86c1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
@@ -529,6 +529,7 @@ local function on_code_action_results(results, ctx)
 
   vim.ui.select(action_tuples, {
     prompt = 'Code actions:',
+    kind = 'codeaction',
     format_item = function(action_tuple)
       local title = action_tuple[2].title:gsub('\r\n', '\\r\\n')
       return title:gsub('\n', '\\n')

diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
@@ -9,6 +9,11 @@ local M = {}
 ---     - format_item (function item -> text)
 ---               Function to format an
 ---               individual item from `items`. Defaults to `tostring`.
+---     - kind (string|nil)
+---               Arbitrary hint string indicating the item shape.
+---               Plugins reimplementing `vim.ui.select` may wish to
+---               use this to infer the structure or semantics of
+---               `items`, or the context in which select() was called.
 ---@param on_choice function ((item|nil, idx|nil) -> ())
 ---               Called once the user made a choice.
 ---               `idx` is the 1-based index of `item` within `item`.