sort references

Sort references so that the list will be in order based on filename,
line number, and start position. Prior to this, multiple invocations of
:GoReferrers would reorder the references and any given invocation may
find that references from the same file may not be in the document
order.

Author: bhcleek

autoload/go/lsp.vim

@@ -681,6 +681,8 @@ endfunction
 function! s:referencesHandler(next, msg) abort dict
   let l:result = []
 
+  call sort(a:msg, funcref('s:compareLocations'))
+
   for l:loc in a:msg
     let l:fname = go#path#FromURI(l:loc.uri)
     let l:line = l:loc.range.start.line+1
@@ -976,6 +978,26 @@ function! s:debug(event, data, ...) abort
   call timer_start(10, function('s:debugasync', [a:event, a:data]))
 endfunction
 
+function! s:compareLocations(left, right) abort
+  if a:left.uri < a:right.uri
+    return -1
+  endif
+
+  if a:left.uri == a:right.uri && a:left.range.start.line < a:right.range.start.line
+    return -1
+  endif
+
+  if a:left.uri == a:right.uri && a:left.range.start.line == a:right.range.start.line && a:left.range.start.character < a:right.range.start.character
+    return -1
+  endif
+
+  if a:left.uri == a:right.uri && a:left.range.start.line == a:right.range.start.line && a:left.range.start.character == a:right.range.start.character
+    return 0
+  endif
+
+  return 1
+endfunction
+
 " restore Vi compatibility settings
 let &cpo = s:cpo_save
 unlet s:cpo_save

doc/vim-go.txt

@@ -1407,11 +1407,11 @@ and `guru`.
 <
                                                        *'g:go_referrers_mode'*
 
-Use this option to define the command to be used for |:GoReferrers|. By default
-`gopls` is used, because it is the fastest and works with Go modules. One
-might also use `guru` for its ability to show references from other packages.
-This option will be removed after `gopls` can show references from other
-packages. Valid options are `gopls` and `guru`.
+Use this option to define the command to be used for |:GoReferrers|. By
+default `gopls` is used, because it is the fastest and works with Go modules.
+One might also use `guru` for its ability to show references from other
+packages.  This option will be removed after `gopls` can show references from
+other packages. Valid options are `gopls` and `guru`.
 >
   let g:go_referrers_mode = 'gopls'
 <