Allow custom server-specific symbol and completion item kind (#524)

* allow customization of symbol_kinds

* allow customization of completion_item_kinds

* make server name optional

* add docs

* slightly rearrange documentation

* Remove trailing whitespace

Author: Christian Clason

autoload/lsp/omni.vim

@@ -1,6 +1,6 @@
 " constants {{{
 
-let s:kind_text_mappings = {
+let s:default_completion_item_kinds = {
             \ '1': 'text',
             \ '2': 'method',
             \ '3': 'function',
@@ -28,6 +28,8 @@ let s:kind_text_mappings = {
             \ '25': 'type parameter',
             \ }
 
+let s:completion_item_kinds = {}
+
 let s:completion_status_success = 'success'
 let s:completion_status_failed = 'failed'
 let s:completion_status_pending = 'pending'
@@ -96,7 +98,7 @@ function! s:handle_omnicompletion(server_name, complete_counter, data) abort
         return
     endif
 
-    let l:result = s:get_completion_result(a:data)
+    let l:result = s:get_completion_result(a:server_name, a:data)
     let l:matches = l:result['matches']
 
     if g:lsp_async_completion
@@ -107,8 +109,25 @@ function! s:handle_omnicompletion(server_name, complete_counter, data) abort
     endif
 endfunction
 
-function! lsp#omni#get_kind_text(completion_item) abort
-    return has_key(a:completion_item, 'kind') && has_key(s:kind_text_mappings, a:completion_item['kind']) ? s:kind_text_mappings[a:completion_item['kind']] : ''
+function! lsp#omni#get_kind_text(completion_item, ...) abort
+    let l:server = get(a:, 1, '')
+    if empty(l:server) " server name 
+        let l:completion_item_kinds = s:default_completion_item_kinds
+    else
+        if !has_key(s:completion_item_kinds, l:server)
+            let l:server_info = lsp#get_server_info(l:server)
+            if has_key (l:server_info, 'config') && has_key(l:server_info['config'], 'completion_item_kinds')
+                let s:completion_item_kinds[l:server] = s:default_completion_item_kinds
+                call extend(s:completion_item_kinds[l:server] , l:server_info['config']['completion_item_kinds'])
+            else
+                let s:completion_item_kinds[l:server] = s:default_completion_item_kinds
+            endif
+        endif
+        let l:completion_item_kinds = s:completion_item_kinds[l:server]
+    endif
+
+    return has_key(a:completion_item, 'kind') && has_key(l:completion_item_kinds, a:completion_item['kind']) 
+                \ ? l:completion_item_kinds[a:completion_item['kind']] : ''
 endfunction
 
 " auxiliary functions {{{
@@ -140,7 +159,7 @@ function! s:send_completion_request(info) abort
                 \ })
 endfunction
 
-function! s:get_completion_result(data) abort
+function! s:get_completion_result(server_name, data) abort
     let l:result = a:data['response']['result']
 
     if type(l:result) == type([])
@@ -154,7 +173,7 @@ function! s:get_completion_result(data) abort
         let l:incomplete = 0
     endif
 
-    let l:matches = type(l:items) == type([]) ? map(l:items, {_, item -> lsp#omni#get_vim_completion_item(item, 1) }) : []
+    let l:matches = type(l:items) == type([]) ? map(l:items, {_, item -> lsp#omni#get_vim_completion_item(item, a:server_name, 1) }) : []
 
     return {'matches': l:matches, 'incomplete': l:incomplete}
 endfunction
@@ -182,7 +201,8 @@ function! s:remove_typed_part(word) abort
 endfunction
 
 function! lsp#omni#default_get_vim_completion_item(item, ...) abort
-    let l:do_remove_typed_part = get(a:, 1, 0)
+    let l:server_name = get(a:, 1, '')
+    let l:do_remove_typed_part = get(a:, 2, 0)
 
     if g:lsp_insert_text_enabled && has_key(a:item, 'insertText') && !empty(a:item['insertText'])
         if has_key(a:item, 'insertTextFormat') && a:item['insertTextFormat'] != 1
@@ -199,7 +219,8 @@ function! lsp#omni#default_get_vim_completion_item(item, ...) abort
     if l:do_remove_typed_part
         let l:word = s:remove_typed_part(l:word)
     endif
-    let l:kind = lsp#omni#get_kind_text(a:item)
+
+    let l:kind = lsp#omni#get_kind_text(a:item, l:server_name)
 
     let l:completion = {
                 \ 'word': l:word,
@@ -370,7 +391,7 @@ function! s:get_cursor_pos_and_edit_length(text_edit) abort
 endfunction
 
 function! lsp#omni#get_completion_item_kinds() abort
-    return map(keys(s:kind_text_mappings), {idx, key -> str2nr(key)})
+    return map(keys(s:default_completion_item_kinds), {idx, key -> str2nr(key)})
 endfunction
 
 " }}}

autoload/lsp/ui/vim.vim

@@ -408,7 +408,7 @@ function! s:handle_symbol(server, last_req_id, type, data) abort
         return
     endif
 
-    let l:list = lsp#ui#vim#utils#symbols_to_loc_list(a:data)
+    let l:list = lsp#ui#vim#utils#symbols_to_loc_list(a:server, a:data)
 
     call setqflist(l:list)
 

autoload/lsp/ui/vim/utils.vim

@@ -65,7 +65,7 @@ function! lsp#ui#vim#utils#locations_to_loc_list(result) abort
     return l:list
 endfunction
 
-let s:symbol_kinds = {
+let s:default_symbol_kinds = {
     \ '1': 'file',
     \ '2': 'module',
     \ '3': 'namespace',
@@ -94,14 +94,16 @@ let s:symbol_kinds = {
     \ '26': 'type parameter',    
     \ }
 
+let s:symbol_kinds = {}
+
 let s:diagnostic_severity = {
     \ 1: 'Error',
     \ 2: 'Warning',
     \ 3: 'Information',
     \ 4: 'Hint',
     \ }
 
-function! lsp#ui#vim#utils#symbols_to_loc_list(result) abort
+function! lsp#ui#vim#utils#symbols_to_loc_list(server, result) abort
     if !has_key(a:result['response'], 'result')
         return []
     endif
@@ -123,7 +125,7 @@ function! lsp#ui#vim#utils#symbols_to_loc_list(result) abort
                     \ 'filename': l:path,
                     \ 'lnum': l:line,
                     \ 'col': l:col,
-                    \ 'text': s:get_symbol_text_from_kind(l:symbol['kind']) . ' : ' . l:symbol['name'],
+                    \ 'text': s:get_symbol_text_from_kind(a:server, l:symbol['kind']) . ' : ' . l:symbol['name'],
                     \ })
             endif
         endfor
@@ -176,12 +178,22 @@ function! s:is_file_uri(uri) abort
     return stridx(a:uri, 'file:///') == 0
 endfunction
 
-function! s:get_symbol_text_from_kind(kind) abort
-    return has_key(s:symbol_kinds, a:kind) ? s:symbol_kinds[a:kind] : 'unknown symbol ' . a:kind
+function! s:get_symbol_text_from_kind(server, kind) abort
+    if !has_key(s:symbol_kinds, a:server)
+        let l:server_info = lsp#get_server_info(a:server)
+        if has_key (l:server_info, 'config') && has_key(l:server_info['config'], 'symbol_kinds')
+            let s:symbol_kinds[a:server] = s:default_symbol_kinds
+            call extend(s:symbol_kinds[a:server], l:server_info['config']['symbol_kinds'])
+        else
+            let s:symbol_kinds[a:server] = s:default_symbol_kinds
+        endif
+    endif
+    let l:symbol_kinds = s:symbol_kinds[a:server]
+    return has_key(l:symbol_kinds, a:kind) ? l:symbol_kinds[a:kind] : 'unknown symbol ' . a:kind
 endfunction
 
 function! lsp#ui#vim#utils#get_symbol_kinds() abort
-    return map(keys(s:symbol_kinds), {idx, key -> str2nr(key)})
+    return map(keys(s:default_symbol_kinds), {idx, key -> str2nr(key)})
 endfunction
 
 function! s:get_diagnostic_severity_text(severity) abort

doc/vim-lsp.txt

@@ -625,6 +625,15 @@ The vim |dict| containing information about the server.
 	'whitelist': ['*']
 	'blacklist': ['javascript', 'typescript']
 
+  * workspace_config:
+    optional vim |dict|
+    Used to pass workspace configuration to the server after
+    initialization. Configuration settings are language-server specific.
+
+    Example:
+	'workspace_config': {'pyls': {'plugins': \
+		{'pydocstyle': {'enabled': v:true}}}}
+
   * config:
     optional vim |dict|
     Used to pass additional custom config.
@@ -646,24 +655,39 @@ The vim |dict| containing information about the server.
 
 	    'cmd': function('s:myserver_cmd')
 
-  * workspace_config:
-    optional vim |dict|
-    Used to pass workspace configuration to the server after
-    initialization. Configuration settings are language-server specific.
+    The following per-server configuration options are supported by vim-lsp.
 
-    Example:
-	'workspace_config': {'pyls': {'plugins': \
-		{'pydocstyle': {'enabled': v:true}}}}
+	* hover_conceal
+	    Type: |Boolean|
+	    Default: |g:lsp_hover_conceal|
 
-hover_conceal                                          *vim-lsp_hover_conceal*
-    Type: |Boolean|
-    Default: |g:lsp_hover_conceal|
+	    This takes precendence over the value of |g:lsp_hover_conceal|, to
+	    allow overriding this setting per server.
 
-    This takes precendence over the value of |g:lsp_hover_conceal|, to allow
-    overriding this setting per server.
+	    Example:
+		'config': { 'hover_conceal': 1 }
 
-    Example:
-        'config': { 'hover_conceal': 1 }
+	* symbol_kinds
+	    Type: |Dict|
+	    Default: |{}|
+
+	    This allows overriding the default text mappings for symbol kinds
+	    (e.g., 'module', 'method') per server. Useful for abbreviating or
+	    removing the kind text.
+
+	    Example:
+		'config': { 'symbol_kinds': {'26': 'type' } }
+
+	* completion_item_kinds
+	    Type: |Dict|
+	    Default: |{}|
+
+	    This allows overriding the default text mappings for completion item
+	    kinds (e.g., 'module', 'method') per server. Useful for abbreviating
+	    or removing the kind text.
+
+	    Example:
+		'config': { 'completion_item_kinds': {'26': 'type' } }
 
 lsp#stop_server                                        *vim-lsp-stop_server*