Show all diagnostics on point on explain error at point buffer (#1204)

Author: martskins

src/language_server_protocol.rs

@@ -3219,64 +3219,64 @@ impl LanguageClient {
         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(|state| {
-            state
+        let diagnostics: Result<Vec<Diagnostic>> = self.get_state(|state| {
+            Ok(state
                 .diagnostics
                 .get(&filename)
                 .ok_or_else(|| anyhow!("No diagnostics found: filename: {}", filename,))?
                 .iter()
-                .find(|dn| position >= dn.range.start && position < dn.range.end)
+                .filter(|dn| position >= dn.range.start && position <= dn.range.end)
                 .cloned()
-                .ok_or_else(|| {
-                    anyhow!(
-                        "No diagnostics found: filename: {}, line: {}, character: {}",
-                        filename,
-                        position.line,
-                        position.character
-                    )
-                })
+                .collect::<Vec<Diagnostic>>())
         })?;
 
-        if silent_mode && diag.is_err() {
+        if silent_mode && diagnostics.is_err() {
             return Ok(Value::Null);
         }
-        let diag = diag?;
+        let diagnostics = diagnostics?;
 
         let language_id = self.vim()?.get_language_id(&filename, params)?;
         let root =
             self.get_state(|state| state.roots.get(&language_id).cloned().unwrap_or_default())?;
         let root_uri = root.to_url()?;
 
-        let mut explanation = diag.message;
-        if let Some(source) = diag.source {
-            explanation = format!("{}: {}\n", source, explanation);
-        }
-        if let Some(related_information) = diag.related_information {
-            explanation = format!("{}\n", explanation);
-            for ri in related_information {
-                let prefix = format!("{}/", root_uri);
-                let uri = if ri.location.uri.as_str().starts_with(prefix.as_str()) {
-                    // Heuristic: if start of stringified URI matches rootUri, abbreviate it away
-                    &ri.location.uri.as_str()[root_uri.as_str().len() + 1..]
-                } else {
-                    ri.location.uri.as_str()
-                };
-                if ri.location.uri.scheme() == "file" {
-                    explanation = format!(
-                        "{}\n{}:{}: {}",
-                        explanation,
-                        uri,
-                        &ri.location.range.start.line + 1,
-                        &ri.message
-                    );
-                } else {
-                    // Heuristic: if scheme is not file, don't show line numbers
-                    explanation = format!("{}\n{}: {}", explanation, uri, &ri.message);
+        let mut explanation = vec![];
+        for (idx, diagnostic) in diagnostics.iter().enumerate() {
+            let mut message = diagnostic.message.clone();
+            if let Some(source) = &diagnostic.source {
+                message = format!("{}: {}", source, message);
+            }
+            message = format!("{}. {}", idx + 1, message);
+
+            if let Some(related_information) = &diagnostic.related_information {
+                for ri in related_information {
+                    let prefix = format!("{}/", root_uri);
+                    let uri = if ri.location.uri.as_str().starts_with(prefix.as_str()) {
+                        // Heuristic: if start of stringified URI matches rootUri, abbreviate it away
+                        &ri.location.uri.as_str()[root_uri.as_str().len() + 1..]
+                    } else {
+                        ri.location.uri.as_str()
+                    };
+                    if ri.location.uri.scheme() == "file" {
+                        message = format!(
+                            "{}\n{}:{}:{}: {}",
+                            message,
+                            uri,
+                            &ri.location.range.start.line + 1,
+                            &ri.location.range.start.character + 1,
+                            &ri.message
+                        );
+                    } else {
+                        // Heuristic: if scheme is not file, don't show line numbers
+                        message = format!("{}\n{}: {}", message, uri, &ri.message);
+                    }
                 }
             }
+
+            explanation.push(message);
         }
 
-        self.preview(explanation.as_str(), "__LCNExplainError__")?;
+        self.preview(explanation.join("\n").as_str(), "__LCNExplainError__")?;
         Ok(Value::Null)
     }
 

tests/LanguageClient_test.py

@@ -9,6 +9,8 @@
 
 
 NVIM_LISTEN_ADDRESS = "/tmp/nvim-LanguageClient-IntegrationTest"
+EXPLAIN_ERROR_BUFFER = "__LCNExplainError__"
+HOVER_BUFFER = "__LCNHover__"
 
 
 project_root = os.path.dirname(os.path.abspath(__file__))
@@ -36,8 +38,8 @@ def assertRetry(predicate, retry_max=100):
     assert predicate()
 
 
-def getLanguageClientBuffers(nvim):
-    return [b for b in nvim.buffers if b.name.endswith("__LCNHover__")]
+def getBufferByName(nvim, name: str):
+    return [b for b in nvim.buffers if b.name.endswith(name)]
 
 
 @pytest.fixture(scope="module")
@@ -52,6 +54,18 @@ def setup(nvim):
     nvim.command("%bdelete!")
 
 
+def test_explainErrorAtPoint(nvim):
+    nvim.command("edit! {}".format(PATH_MAIN_GO))
+    time.sleep(1)
+    nvim.funcs.cursor(26, 2)
+    nvim.funcs.LanguageClient_explainErrorAtPoint()
+    time.sleep(1)
+    buf = getBufferByName(nvim, EXPLAIN_ERROR_BUFFER)[0]
+    expect = "1. assign: self-assignment of x to x"
+
+    assert expect in "\n".join(buf)
+
+
 def test_textDocument_definition(nvim):
     nvim.command("edit! {}".format(PATH_MAIN_GO))
     time.sleep(2)
@@ -68,7 +82,7 @@ def test_textDocument_hover(nvim):
     nvim.funcs.cursor(10, 16)
     nvim.funcs.LanguageClient_textDocument_hover()
     time.sleep(1)
-    buf = getLanguageClientBuffers(nvim)[0]
+    buf = getBufferByName(nvim, HOVER_BUFFER)[0]
     expect = "func greet() int32"
 
     assert expect in "\n".join(buf)
@@ -136,22 +150,22 @@ def test_workspace_symbol(nvim):
     nvim.command("edit! {}".format(PATH_MAIN_GO))
     time.sleep(1)
     nvim.funcs.cursor(1, 1)
-    nvim.funcs.LanguageClient_workspace_symbol()
+    nvim.funcs.LanguageClient_workspace_symbol('yo')
     time.sleep(1)
 
     assert nvim.funcs.getloclist(0)
 
-    nvim.command("3lnext")
+    nvim.command("lnext")
 
-    assert nvim.current.window.cursor == [17, 0]
+    assert nvim.current.window.cursor == [24, 5]
 
 
 def test_textDocument_references(nvim):
     nvim.command("edit! {}".format(PATH_MAIN_GO))
     time.sleep(1)
     nvim.funcs.cursor(13, 6)
     nvim.funcs.LanguageClient_textDocument_references()
-    time.sleep(2)
+    time.sleep(3)
     expect = ["func greet() int32 {", "log.Println(greet())",
               "log.Println(greet())"]
 
@@ -239,7 +253,7 @@ def test_textDocument_hover_float_window_closed_on_cursor_moved(nvim):
 
     pos = _open_float_window(nvim)
 
-    float_buf = getLanguageClientBuffers(nvim)[0]
+    float_buf = getBufferByName(nvim, HOVER_BUFFER)[0]
 
     # Check if float window is open
     float_winnr = nvim.funcs.bufwinnr(float_buf.number)
@@ -253,7 +267,7 @@ def test_textDocument_hover_float_window_closed_on_cursor_moved(nvim):
     nvim.funcs.cursor(10, 14)
 
     # Check float window buffer was closed by CursorMoved
-    assert len(getLanguageClientBuffers(nvim)) == 0
+    assert len(getBufferByName(nvim, HOVER_BUFFER)) == 0
 
 
 def test_textDocument_hover_float_window_closed_on_entering_window(nvim):
@@ -276,7 +290,7 @@ def test_textDocument_hover_float_window_closed_on_entering_window(nvim):
         assert win_id == nvim.funcs.win_getid()
 
         # Check float window buffer was closed by BufEnter
-        assert len(getLanguageClientBuffers(nvim)) == 0
+        assert len(getBufferByName(nvim, HOVER_BUFFER)) == 0
     finally:
         nvim.command("close!")
 
@@ -298,7 +312,7 @@ def test_textDocument_hover_float_window_closed_on_switching_to_buffer(nvim):
 
         _open_float_window(nvim)
 
-        float_buf = getLanguageClientBuffers(nvim)[0]
+        float_buf = getBufferByName(nvim, HOVER_BUFFER)[0]
         float_winnr = nvim.funcs.bufwinnr(float_buf.number)
         assert float_winnr > 0
 
@@ -309,7 +323,7 @@ def test_textDocument_hover_float_window_closed_on_switching_to_buffer(nvim):
         assert nvim.current.buffer.number == another_bufnr
 
         # Check float window buffer was closed by BufEnter
-        assert len(getLanguageClientBuffers(nvim)) == 0
+        assert len(getBufferByName(nvim, HOVER_BUFFER)) == 0
     finally:
         nvim.command("bdelete! {}".format(another_bufnr))
 
@@ -334,4 +348,4 @@ def test_textDocument_hover_float_window_move_cursor_into_window(nvim):
     assert nvim.current.buffer.number == prev_bufnr
 
     # Check float window buffer was closed by :close in the window
-    assert len(getLanguageClientBuffers(nvim)) == 0
+    assert len(getBufferByName(nvim, HOVER_BUFFER)) == 0

tests/data/sample-go/main.go

@@ -20,3 +20,8 @@ func yo() {
 	log.Println(b)
 	log.Println(otherYo())
 }
+
+func yoWithDiagnostic() {
+	x := 0
+	x = x
+}