Add parameter to silence explainErrorAtPoint (autozimu#1143)

Author: martskins

autoload/LanguageClient.vim

@@ -585,9 +585,9 @@ function! s:OpenHoverPreview(bufname, lines, filetype, ...) abort
  endif
 endfunction
 
-function! s:MoveIntoHoverPreview() abort
+function! s:MoveIntoHoverPreview(bufname) abort
  for bufnr in range(1, bufnr('$'))
- if bufname(bufnr) ==# '__LanguageClient__'
+ if bufname(bufnr) ==# a:bufname
  let winnr = bufwinnr(bufnr)
  if winnr != -1
  execute winnr . 'wincmd w'
@@ -890,7 +890,7 @@ function! LanguageClient#Notify(method, params) abort
 endfunction
 
 function! LanguageClient#textDocument_hover(...) abort
- if s:ShouldUseFloatWindow() && s:MoveIntoHoverPreview()
+ if s:ShouldUseFloatWindow() && s:MoveIntoHoverPreview('__LCNHover__')
  return
  endif
  let l:Callback = get(a:000, 1, v:null)
@@ -1378,7 +1378,9 @@ function! LanguageClient_NCM2OnComplete(context) abort
 endfunction
 
 function! LanguageClient#explainErrorAtPoint(...) abort
- if s:ShouldUseFloatWindow() && s:MoveIntoHoverPreview()
+ let extra = get(a:000, 0, {})
+ let silent_mode = get(extra, 'silent', v:false)
+ if s:ShouldUseFloatWindow() && !silent_mode && s:MoveIntoHoverPreview('__LCNExplainError__')
  return
  endif
 
@@ -1390,7 +1392,7 @@ function! LanguageClient#explainErrorAtPoint(...) abort
  \ 'character': LSP#character(),
  \ 'handle': s:IsFalse(l:Callback),
  \ }
- call extend(l:params, get(a:000, 0, {}))
+ call extend(l:params, extra)
  return LanguageClient#Call('languageClient/explainErrorAtPoint', l:params, l:Callback)
 endfunction
 

src/language_server_protocol.rs

@@ -1049,11 +1049,10 @@ impl LanguageClient {
  Ok(())
  }
 
- fn preview<D>(&self, to_display: &D) -> Result<()>
+ fn preview<D>(&self, to_display: &D, bufname: &str) -> Result<()>
  where
  D: ToDisplay + ?Sized,
  {
- let bufname = "__LanguageClient__";
  let filetype = &to_display.vim_filetype();
  let lines = to_display.to_display();
 
@@ -1286,7 +1285,7 @@ impl LanguageClient {
  HoverPreviewOption::Auto => hover.lines_len() > 1,
  };
  if use_preview {
- self.preview(&hover)?
+ self.preview(&hover, "__LCNHover__")?
  } else {
  self.vim()?.echo_ellipsis(hover.to_string())?
  }
@@ -3528,6 +3527,7 @@ impl LanguageClient {
 
  #[tracing::instrument(level = "info", skip(self))]
  pub fn explain_error_at_point(&self, params: &Value) -> Result<Value> {
+ let silent_mode: bool = try_get("silent", params)?.unwrap_or_default();
  let filename = self.vim()?.get_filename(params)?;
  let position = self.vim()?.get_position(params)?;
  let diag = self.get(|state| {
@@ -3546,7 +3546,12 @@ impl LanguageClient {
  position.character
  )
  })
- })??;
+ })?;
+
+ if silent_mode && diag.is_err() {
+ return Ok(Value::Null);
+ }
+ let diag = diag?;
 
  let language_id = self.vim()?.get_language_id(&filename, params)?;
  let root = self.get(|state| state.roots.get(&language_id).cloned().unwrap_or_default())?;
@@ -3581,7 +3586,7 @@ impl LanguageClient {
  }
  }
 
- self.preview(explanation.as_str())?;
+ self.preview(explanation.as_str(), "__LCNExplainError__")?;
  Ok(Value::Null)
  }
 

tests/LanguageClient_test.py

@@ -39,7 +39,7 @@ def assertRetry(predicate, retry_max=100):
 
 
 def getLanguageClientBuffers(nvim):
- return [b for b in nvim.buffers if b.name.endswith("__LanguageClient__")]
+ return [b for b in nvim.buffers if b.name.endswith("__LCNHover__")]
 
 
 @pytest.fixture(scope="module")
@@ -324,7 +324,7 @@ def test_textDocument_hover_float_window_move_cursor_into_window(nvim):
 
  # Moves cursor into floating window
  nvim.funcs.LanguageClient_textDocument_hover()
- assert nvim.current.buffer.name.endswith("__LanguageClient__")
+ assert nvim.current.buffer.name.endswith("__LCNHover__")
 
  # Close the window
  nvim.command('close')