populate location list with all modified changes in a WorkspaceEdit (#555)

Author: williamboman

autoload/lsp/utils/location.vim

@@ -53,6 +53,7 @@ endfunction
 "   'filename',
 "   'lnum',
 "   'col',
+"   'text',
 "   'viewstart?',
 "   'viewend?',
 " }

autoload/lsp/utils/text_edit.vim

@@ -14,6 +14,70 @@ function! lsp#utils#text_edit#apply_text_edits(uri, text_edits) abort
     endif
 endfunction
 
+" @summary Use this to convert textedit to vim list that is compatible with
+" quickfix and locllist items
+" @param uri = DocumentUri
+" @param text_edit = TextEdit | TextEdit[]
+" @returns []
+function! lsp#utils#text_edit#_lsp_to_vim_list(uri, text_edit) abort
+    let l:result = []
+    let l:cache = {}
+    if type(a:text_edit) == type([]) " TextEdit[]
+        for l:text_edit in a:text_edit
+            let l:vim_loc = s:lsp_text_edit_item_to_vim(a:uri, l:text_edit, l:cache)
+            if !empty(l:vim_loc)
+                call add(l:result, l:vim_loc)
+            endif
+        endfor
+    else " TextEdit
+        let l:vim_loc = s:lsp_text_edit_item_to_vim(a:uri, a:text_edit, l:cache)
+        if !empty(l:vim_loc)
+            call add(l:result, l:vim_loc)
+        endif
+    endif
+    return l:result
+endfunction
+
+" @param uri = DocumentUri
+" @param text_edit = TextEdit
+" @param cache = {} empty dict
+" @returns {
+"   'filename',
+"   'lnum',
+"   'col',
+"   'text',
+" }
+function! s:lsp_text_edit_item_to_vim(uri, text_edit, cache) abort
+    if !lsp#utils#is_file_uri(a:uri)
+        return v:null
+    endif
+
+    let l:path = lsp#utils#uri_to_path(a:uri)
+    let l:range = a:text_edit['range']
+    let [l:line, l:col] = lsp#utils#position#lsp_to_vim(l:path, l:range['start'])
+
+    let l:index = l:line - 1
+    if has_key(a:cache, l:path)
+        let l:text = a:cache[l:path][l:index]
+    else
+        let l:contents = getbufline(l:path, 1, '$')
+        if !empty(l:contents)
+            let l:text = get(l:contents, l:index, '')
+        else
+            let l:contents = readfile(l:path)
+            let a:cache[l:path] = l:contents
+            let l:text = get(l:contents, l:index, '')
+        endif
+    endif
+
+    return {
+        \ 'filename': l:path,
+        \ 'lnum': l:line,
+        \ 'col': l:col,
+        \ 'text': l:text
+        \ }
+endfunction
+
 "
 " _apply
 "

autoload/lsp/utils/workspace_edit.vim

@@ -1,12 +1,27 @@
 " Applies WorkspaceEdit changes.
 function! lsp#utils#workspace_edit#apply_workspace_edit(workspace_edit) abort
+    let l:loclist_items = []
+
     if has_key(a:workspace_edit, 'documentChanges')
         for l:text_document_edit in a:workspace_edit['documentChanges']
-            call lsp#utils#text_edit#apply_text_edits(l:text_document_edit['textDocument']['uri'], l:text_document_edit['edits'])
+            let l:loclist_items += s:_apply(l:text_document_edit['textDocument']['uri'], l:text_document_edit['edits'])
         endfor
     elseif has_key(a:workspace_edit, 'changes')
         for [l:uri, l:text_edits] in items(a:workspace_edit['changes'])
-            call lsp#utils#text_edit#apply_text_edits(l:uri, l:text_edits)
+            let l:loclist_items += s:_apply(l:uri, l:text_edits)
         endfor
     endif
+
+    if g:lsp_show_workspace_edits
+        call setloclist(0, l:loclist_items, 'r')
+        execute 'lopen'
+    endif
+endfunction
+
+"
+" _apply
+"
+function! s:_apply(uri, text_edits) abort
+    call lsp#utils#text_edit#apply_text_edits(a:uri, a:text_edits)
+    return lsp#utils#text_edit#_lsp_to_vim_list(a:uri, a:text_edits)
 endfunction

doc/vim-lsp.txt

@@ -617,6 +617,17 @@ g:lsp_signature_help_enabled                *g:lsp_signature_help_enabled*
 	let g:lsp_signature_help_enabled = 1
 	let g:lsp_signature_help_enabled = 0
 
+g:lsp_show_workspace_edits                     *g:lsp_show_workspace_edits*
+    Type: |Boolean|
+    Default: `0`
+
+    Enable showing changes made in a workspace edit in the |location-list|.
+    Set to `0` to disable.
+
+    Example: >
+	let g:lsp_show_workspace_edits = 1
+	let g:lsp_show_workspace_edits = 0
+
 g:lsp_fold_enabled                                    *g:lsp_fold_enabled*
     Type: |Number|
     Default: `1`

plugin/lsp.vim

@@ -41,6 +41,7 @@ let g:lsp_peek_alignment = get(g:, 'lsp_peek_alignment', 'center')
 let g:lsp_preview_max_width = get(g:, 'lsp_preview_max_width', -1)
 let g:lsp_preview_max_height = get(g:, 'lsp_preview_max_height', -1)
 let g:lsp_signature_help_enabled = get(g:, 'lsp_signature_help_enabled', 1)
+let g:lsp_show_workspace_edits = get(g:, 'lsp_show_workspace_edits', 0)
 let g:lsp_fold_enabled = get(g:, 'lsp_fold_enabled', 1)
 let g:lsp_hover_conceal = get(g:, 'lsp_hover_conceal', 1)
 let g:lsp_ignorecase = get(g:, 'lsp_ignorecase', &ignorecase)

test/lsp/utils/workspace_edit.vimspec

@@ -0,0 +1,81 @@
+Describe lsp#utils#workspace_edit
+
+    Describe lsp#utils#text_edit#apply_workspace_edit
+        It populates location list with changes
+            let g:lsp_show_workspace_edits = 1
+
+            call lsp#utils#workspace_edit#apply_workspace_edit({
+                \ 'documentChanges': [{
+                \     'textDocument': { 'uri': 'file:///path/to/file' },
+                \     'edits': [
+                \         {
+                \           "range": {
+                \             "start": {
+                \               "character": 0,
+                \               "line": 1
+                \             },
+                \             "end": {
+                \               "character": 0,
+                \               "line": 1
+                \             }
+                \           },
+                \           "newText": "import java.util.LinkedList;"
+                \         },
+                \         {
+                \           "range": {
+                \             "start": {
+                \               "character": 0,
+                \               "line": 0
+                \             },
+                \             "end": {
+                \               "character": 0,
+                \               "line": 0
+                \             }
+                \           },
+                \           "newText": "import java.util.ArrayList;"
+                \         }
+                \     ]
+                \ }]})
+
+            let l:loclist = getloclist(0)
+
+            Assert Equals(len(l:loclist), 2)
+
+            Assert Equals(l:loclist[0]['lnum'], 2)
+            Assert Equals(l:loclist[0]['col'], 1)
+            Assert Equals(l:loclist[0]['text'], 'import java.util.LinkedList;')
+
+            Assert Equals(l:loclist[1]['lnum'], 1)
+            Assert Equals(l:loclist[1]['col'], 1)
+            Assert Equals(l:loclist[1]['text'], 'import java.util.ArrayList;')
+
+        end
+
+        It should not set location list if not enabled
+            let g:lsp_show_workspace_edits = 0
+
+            call lsp#utils#workspace_edit#apply_workspace_edit({
+                \ 'documentChanges': [{
+                \     'textDocument': { 'uri': 'file:///path/to/file' },
+                \     'edits': [
+                \         {
+                \           "range": {
+                \             "start": {
+                \               "character": 0,
+                \               "line": 3
+                \             },
+                \             "end": {
+                \               "character": 0,
+                \               "line": 3
+                \             }
+                \           },
+                \           "newText": "import java.util.LinkedList;"
+                \         }
+                \     ]
+                \ }]})
+
+            Assert Equals(len(getloclist(0)), 0)
+        End
+    End
+End
+