Improve implementation and add docs

Author: hrsh7th

autoload/lsp/internal/linked_editing_range.vim

@@ -12,14 +12,14 @@ function! lsp#internal#linked_editing_range#_enable() abort
     if !s:TextEdit.is_text_mark_preserved()
         return
     endif
-
     if !g:lsp_linked_editing_range_enabled | return | endif
+
     let s:Dispose = lsp#callbag#merge(
     \     lsp#callbag#pipe(
     \         lsp#callbag#fromEvent(['InsertEnter']),
-    \         lsp#callbag#flatMap({ -> s:request(v:false) }),
+    \         lsp#callbag#flatMap({ -> s:request_sync() }),
     \         lsp#callbag#subscribe({
-    \           'next': { x -> s:prepare(x) }
+    \           'next': { x -> call('s:prepare', x) }
     \         })
     \     ),
     \     lsp#callbag#pipe(
@@ -42,43 +42,52 @@ function! lsp#internal#linked_editing_range#_disable() abort
     endif
 endfunction
 
-function! s:request(sync) abort
+function! lsp#internal#linked_editing_range#prepare() abort
+    if !s:TextEdit.is_text_mark_preserved()
+        return ''
+    endif
+    if !g:lsp_linked_editing_range_enabled
+        return ''
+    endif
+
+    call lsp#callbag#pipe(
+    \     s:request_sync(),
+    \     lsp#callbag#subscribe({
+    \         'next': { x -> call('s:prepare', x) },
+    \         'error': { -> {} },
+    \     })
+    \ )
+    return ''
+endfunction
+
+function! s:request_sync() abort
     let l:server = lsp#get_allowed_servers(&filetype)
     let l:server = filter(l:server, 'lsp#capabilities#has_linked_editing_range_provider(v:val)')
     let l:server = get(l:server, 0, v:null)
     if empty(l:server)
-        return lsp#callbag#empty()
+        return lsp#callbag#of([v:null])
     endif
 
-    let l:X = lsp#callbag#pipe(
-    \     lsp#request(l:server, {
-    \         'method': 'textDocument/linkedEditingRange',
-    \         'params': {
-    \             'textDocument': lsp#get_text_document_identifier(),
-    \             'position': lsp#get_position(),
-    \         }
-    \     }),
+    return lsp#callbag#of(
+    \     lsp#callbag#pipe(
+    \         lsp#request(l:server, {
+    \             'method': 'textDocument/linkedEditingRange',
+    \             'params': {
+    \                 'textDocument': lsp#get_text_document_identifier(),
+    \                 'position': lsp#get_position(),
+    \             }
+    \         }),
+    \         lsp#callbag#toList()
+    \     ).wait({ 'sleep': 1, 'timeout': 200 })
     \ )
-    if a:sync
-      return lsp#callbag#of(
-      \     get(
-      \         lsp#callbag#pipe(
-      \             l:X,
-      \             lsp#callbag#toList()
-      \         ).wait({ 'sleep': 1, 'timeout': 200 }),
-      \        0,
-      \        v:null
-      \     )
-      \ )
-    endif
-    return l:X
 endfunction
 
 function! s:prepare(x) abort
-    if empty(get(a:x['response']['result'], 'ranges', {}))
-      return
+    if empty(a:x) || empty(get(a:x, 'response')) || empty(get(a:x['response'], 'result')) || empty(get(a:x['response']['result'], 'ranges'))
+        return
     endif
 
+    call s:clear()
     call s:TextMark.set(bufnr('%'), s:TEXT_MARK_NAMESPACE, map(a:x['response']['result']['ranges'], { _, range -> {
     \     'range': range,
     \     'highlight': 'Underlined',
@@ -100,7 +109,7 @@ function! s:sync() abort
     if s:state['changedtick'] == b:changedtick
         return
     endif
-    if s:state['changenr'] >  changenr()
+    if s:state['changenr'] > changenr()
         return
     endif
 

doc/vim-lsp.txt

@@ -50,6 +50,7 @@ CONTENTS                                                  *vim-lsp-contents*
 			     |g:lsp_diagnostics_virtual_text_delay|
       g:lsp_diagnostics_virtual_text_prefix
 			     |g:lsp_diagnostics_virtual_text_prefix|
+      g:lsp_linked_editing_range_enabled    |g:lsp_linked_editing_range_enabled|
       g:lsp_format_sync_timeout             |g:lsp_format_sync_timeout|
       g:lsp_use_event_queue                 |g:lsp_use_event_queue|
       g:lsp_document_highlight_enabled      |g:lsp_document_highlight_enabled|
@@ -680,6 +681,28 @@ g:lsp_diagnostics_virtual_text_prefix   *g:lsp_diagnostics_virtual_text_prefix*
 	let g:lsp_diagnostics_virtual_text_prefix = "> "
 	let g:lsp_diagnostics_virtual_text_prefix = " ‣ "
 
+g:lsp_linked_editing_enabled                  *g:lsp_linked_editing_enabled*
+    Type: |Number|
+    Default: `1`
+
+    Enable textDocument/linkedEditingRange feature.
+
+    NOTE: This only works on the environment has `nvim_buf_set_text` for now.
+
+    Example: >
+	let g:lsp_linked_editing_enabled = 1
+	let g:lsp_linked_editing_enabled = 0
+
+	" The below mappings enable to support `d` or `c` commands.
+	nnoremap <buffer> <Plug>(vimrc-d) d
+	xnoremap <buffer> <Plug>(vimrc-d) d
+	nnoremap <buffer> <Plug>(vimrc-c) c
+	xnoremap <buffer> <Plug>(vimrc-c) c
+	nmap <buffer> d <Plug>(lsp-linked-editing-range-prepare)<Plug>(vimrc-d)
+	xmap <buffer> d <Plug>(lsp-linked-editing-range-prepare)<Plug>(vimrc-d)
+	nmap <buffer> c <Plug>(lsp-linked-editing-range-prepare)<Plug>(vimrc-c)
+	xmap <buffer> c <Plug>(lsp-linked-editing-range-prepare)<Plug>(vimrc-c)
+
 g:lsp_use_event_queue                               *g:lsp_use_event_queue*
     Type: |Number|
     Default: `1` for neovim or vim with patch-8.1.0889

plugin/lsp.vim

@@ -167,3 +167,6 @@ nnoremap <plug>(lsp-status) :<c-u>echo lsp#get_server_status()<cr>
 nnoremap <plug>(lsp-next-reference) :<c-u>call lsp#internal#document_highlight#jump(+1)<cr>
 nnoremap <plug>(lsp-previous-reference) :<c-u>call lsp#internal#document_highlight#jump(-1)<cr>
 nnoremap <plug>(lsp-signature-help) :<c-u>call lsp#ui#vim#signature_help#get_signature_help_under_cursor()<cr>
+nnoremap <expr> <plug>(lsp-linked-editing-range-prepare) lsp#internal#linked_editing_range#prepare()
+xnoremap <expr> <plug>(lsp-linked-editing-range-prepare) lsp#internal#linked_editing_range#prepare()
+