docs(completion): add note about vim.lsp.protocol.CompletionItemKind

Author: echasnovski

doc/mini-completion.txt

@@ -73,10 +73,16 @@ You can override runtime config settings locally to buffer inside
     `lsp_completion = {source_func = 'omnifunc', auto_setup = false}`.
     - In `on_attach()` of every LSP client set 'omnifunc' option to exactly
       `v:lua.MiniCompletion.completefunc_lsp`.
+
+- Uses `vim.lsp.protocol.CompletionItemKind` map in LSP step to show a readable
+  version of item's kind. Modify it directly to change what is displayed.
+  If you have |mini.icons| enabled, take a look at |MiniIcons.tweak_lsp_kind()|.
+
 - If you have trouble using custom (overridden) |vim.ui.input| (like from
   'stevearc/dressing.nvim'), make automated disable of 'mini.completion'
   for input buffer. For example, currently for 'dressing.nvim' it can be
   with `au FileType DressingInput lua vim.b.minicompletion_disable = true`.
+
 - Support of `additionalTextEdits` tries to handle both types of servers:
     - When `additionalTextEdits` are supplied in response to
       'textDocument/completion' request (like currently in 'pyright').

lua/mini/completion.lua

@@ -73,10 +73,16 @@
 ---     `lsp_completion = {source_func = 'omnifunc', auto_setup = false}`.
 ---     - In `on_attach()` of every LSP client set 'omnifunc' option to exactly
 ---       `v:lua.MiniCompletion.completefunc_lsp`.
+---
+--- - Uses `vim.lsp.protocol.CompletionItemKind` map in LSP step to show a readable
+---   version of item's kind. Modify it directly to change what is displayed.
+---   If you have |mini.icons| enabled, take a look at |MiniIcons.tweak_lsp_kind()|.
+---
 --- - If you have trouble using custom (overridden) |vim.ui.input| (like from
 ---   'stevearc/dressing.nvim'), make automated disable of 'mini.completion'
 ---   for input buffer. For example, currently for 'dressing.nvim' it can be
 ---   with `au FileType DressingInput lua vim.b.minicompletion_disable = true`.
+---
 --- - Support of `additionalTextEdits` tries to handle both types of servers:
 ---     - When `additionalTextEdits` are supplied in response to
 ---       'textDocument/completion' request (like currently in 'pyright').

tests/screenshots/tests-test_completion.lua---Manual-completion---uses-`vim.lsp.protocol.CompletionItemKind`-in-LSP-step

@@ -0,0 +1,37 @@
+--|---------|---------|---------|
+01|Jackpot                       
+02|                              
+03|January   Text                
+04|February  Text                
+05|March     Method              
+06|April     Method              
+07|May       Method              
+08|June      S Something         
+09|July      S Something         
+10|August    S Something         
+11|September Fallback            
+12|October   Fallback            
+13|November  Fallback            
+14|December  Text                
+15|~                             
+16|[No Name] [+]  2,1         All
+17|-- INSERT --                  
+
+--|---------|---------|---------|
+01|000000000000000000000000000000
+02|000000000000000000000000000000
+03|111111111111111111111122222222
+04|111111111111111111111122222222
+05|111111111111111111111122222222
+06|111111111111111111111122222222
+07|111111111111111111111122222222
+08|111111111111111111111122222222
+09|111111111111111111111122222222
+10|111111111111111111111122222222
+11|111111111111111111111122222222
+12|111111111111111111111122222222
+13|111111111111111111111122222222
+14|111111111111111111111122222222
+15|222222222222222222222222222222
+16|333333333333333333333333333333
+17|444444444444555555555555555555

tests/test_completion.lua

@@ -439,6 +439,20 @@ T['Manual completion']['works with two-step completion'] = function()
   eq(get_completion(), { 'Jackpot' })
 end
 
+T['Manual completion']['uses `vim.lsp.protocol.CompletionItemKind` in LSP step'] = function()
+  child.set_size(17, 30)
+  child.lua([[vim.lsp.protocol = {
+    CompletionItemKind = {
+      [1] = 'Text',         Text = 1,
+      [2] = 'Method',       Method = 2,
+      [3] = 'S Something',  ['S Something'] = 3,
+      [4] = 'Fallback',     Fallback = 4,
+    },
+  }]])
+  type_keys('i', '<C-Space>')
+  child.expect_screenshot()
+end
+
 T['Manual completion']['works with fallback action'] = function()
   type_keys('i', 'J', '<M-Space>')
   eq(get_completion(), { 'Jackpot' })