Add function and plug mappings to cycle diagnostics (#1075)

* Add function and plug mappings to cycle diagnostics

* Fix lint errors

Author: martskins

autoload/LanguageClient.vim

@@ -1050,6 +1050,22 @@ function! LanguageClient#setLoggingLevel(level) abort
     return LanguageClient#Call('languageClient/setLoggingLevel', l:params, v:null)
 endfunction
 
+function! LanguageClient#diagnosticsPrevious() abort
+    let l:params = {
+                \ 'filename': LSP#filename(),
+                \ 'position': LSP#position(),
+                \ }
+    return LanguageClient#Notify('languageClient/diagnosticsPrevious', l:params)
+endfunction
+
+function! LanguageClient#diagnosticsNext() abort
+    let l:params = {
+                \ 'filename': LSP#filename(),
+                \ 'position': LSP#position(),
+                \ }
+    return LanguageClient#Notify('languageClient/diagnosticsNext', l:params)
+endfunction
+
 function! LanguageClient#setDiagnosticsList(diagnosticsList) abort
     let l:params = {
                 \ 'diagnosticsList': a:diagnosticsList,

doc/LanguageClient.txt

@@ -912,6 +912,17 @@ Signature: LanguageClient#debugInfo(...)
 
 Print out debug info.
 
+*LanguageClient#diagnosticsNext*
+Signature: LanguageClient#diagnosticsNext()
+
+Moves the cursor to the next diagnostic in the buffer, relative to the current cursor position.
+
+*LanguageClient#diagnosticsPrevious*
+Signature: LanguageClient#diagnosticsPrevious()
+
+Moves the cursor to the previous diagnostic in the buffer, relative to the current cursor position.
+
+
 ==============================================================================
 5. Mappings                                           *LanguageClientMappings*
 
@@ -966,6 +977,12 @@ Calls LanguageClient_textDocument_formatting.
 *(lcn-format-sync)*
 Calls LanguageClient_textDocument_formatting_sync.
 
+*(lcn-diagnostics-next)*
+Calls LanguageClient_diagnosticsNext.
+
+*(lcn-diagnostics-prev)*
+Calls LanguageClient_diagnosticsPrevious.
+
 
 ==============================================================================
 6. Events                                               *LanguageClientEvents*

plugin/LanguageClient.vim

@@ -110,6 +110,14 @@ function! LanguageClient_statusLine(...)
     return call('LanguageClient#statusLine', a:000)
 endfunction
 
+function! LanguageClient_diagnosticsPrevious(...)
+    return call('LanguageClient#diagnosticsPrevious', a:000)
+endfunction
+
+function! LanguageClient_diagnosticsNext(...)
+    return call('LanguageClient#diagnosticsNext', a:000)
+endfunction
+
 function! LanguageClient_statusLineDiagnosticsCounts(...)
     return call('LanguageClient#statusLineDiagnosticsCounts', a:000)
 endfunction
@@ -178,4 +186,6 @@ augroup languageClient
     nnoremap <Plug>(lcn-explain-error)      :call LanguageClient_explainErrorAtPoint()<CR>
     nnoremap <Plug>(lcn-format)             :call LanguageClient_textDocument_formatting()<CR>
     nnoremap <Plug>(lcn-format-sync)        :call LanguageClient_textDocument_formatting_sync()<CR>
+    nnoremap <Plug>(lcn-diagnostics-next)   :call LanguageClient_diagnosticsNext()<CR>
+    nnoremap <Plug>(lcn-diagnostics-prev)   :call LanguageClient_diagnosticsPrevious()<CR>
 augroup END

src/language_server_protocol.rs

@@ -58,6 +58,12 @@ use std::{
     time::{Duration, Instant},
 };
 
+#[derive(PartialEq)]
+pub enum Direction {
+    Next,
+    Previous,
+}
+
 impl LanguageClient {
     pub fn get_client(&self, language_id: &LanguageId) -> Result<Arc<RpcClient>> {
         self.get(|state| state.clients.get(language_id).cloned())?
@@ -607,6 +613,45 @@ impl LanguageClient {
         Ok(position)
     }
 
+    // moves the cursor to the next or previous diagnostic, depending on the value of direction.
+    pub fn cycle_diagnostics(&self, params: &Value, direction: Direction) -> Result<()> {
+        let filename = self.vim()?.get_filename(params)?;
+        let pos = self.vim()?.get_position(params)?;
+        let mut diagnostics = self.get(|state| state.diagnostics.clone())?;
+        if let Some(diagnostics) = diagnostics.get_mut(&filename) {
+            if direction == Direction::Next {
+                diagnostics.sort_by_key(|edit| (edit.range.start.line, edit.range.start.character));
+            } else {
+                diagnostics.sort_by_key(|edit| {
+                    (
+                        -(edit.range.start.line as i64),
+                        -(edit.range.start.character as i64),
+                    )
+                });
+            }
+
+            let (line, col) = (pos.line, pos.character);
+            if let Some((_, diagnostic)) = diagnostics.iter_mut().find_position(|it| {
+                let start = it.range.start;
+                if direction == Direction::Next {
+                    start.line > line || (start.line == line && start.character > col)
+                } else {
+                    start.line < line || (start.line == line && start.character < col)
+                }
+            }) {
+                let line = diagnostic.range.start.line + 1;
+                let col = diagnostic.range.start.character + 1;
+                let _: String = self.vim()?.rpcclient.call("cursor", json!([line, col]))?;
+            } else {
+                self.vim()?.echomsg("No diagnostics found")?;
+            }
+        } else {
+            self.vim()?.echomsg("No diagnostics found")?;
+        }
+
+        Ok(())
+    }
+
     fn update_quickfixlist(&self) -> Result<()> {
         let diagnostics = self.get(|state| state.diagnostics.clone())?;
         let qflist: Vec<_> = diagnostics

src/rpchandler.rs

@@ -1,4 +1,4 @@
-use crate::{language_client::LanguageClient, types::*};
+use crate::{language_client::LanguageClient, language_server_protocol::Direction, types::*};
 use anyhow::{anyhow, Result};
 use log::*;
 use lsp_types::notification::{self, Notification};
@@ -196,6 +196,10 @@ impl LanguageClient {
             NOTIFICATION_RUST_BEGIN_BUILD => self.rust_handle_begin_build(&params)?,
             NOTIFICATION_RUST_DIAGNOSTICS_BEGIN => self.rust_handle_diagnostics_begin(&params)?,
             NOTIFICATION_RUST_DIAGNOSTICS_END => self.rust_handle_diagnostics_end(&params)?,
+            NOTIFICATION_DIAGNOSTICS_NEXT => self.cycle_diagnostics(&params, Direction::Next)?,
+            NOTIFICATION_DIAGNOSTICS_PREVIOUS => {
+                self.cycle_diagnostics(&params, Direction::Previous)?
+            }
 
             _ => {
                 let language_id_target = if language_id.is_some() {

src/types.rs

@@ -81,6 +81,8 @@ pub const NOTIFICATION_RUST_DIAGNOSTICS_BEGIN: &str = "rustDocument/diagnosticsB
 pub const NOTIFICATION_RUST_DIAGNOSTICS_END: &str = "rustDocument/diagnosticsEnd";
 pub const NOTIFICATION_WINDOW_PROGRESS: &str = "window/progress";
 pub const NOTIFICATION_LANGUAGE_STATUS: &str = "language/status";
+pub const NOTIFICATION_DIAGNOSTICS_NEXT: &str = "languageClient/diagnosticsNext";
+pub const NOTIFICATION_DIAGNOSTICS_PREVIOUS: &str = "languageClient/diagnosticsPrevious";
 
 pub const VIM_SERVER_STATUS: &str = "g:LanguageClient_serverStatus";
 pub const VIM_SERVER_STATUS_MESSAGE: &str = "g:LanguageClient_serverStatusMessage";