fix(diagnostic): preserve fields from LSP diagnostics via user_data (#15735)

gpanders · web-flow · commit 17b7968f02bc · 2021-09-21T15:27:12.000-07:00
* preserve fields from LSP diagnostics via adding a user_data table to the diagnostic, which can hold arbitrary data in addition to the lsp diagnostic information.
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
@@ -102,15 +102,24 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
       end_lnum = _end.line,
       end_col = line_byte_from_position(buf_lines, _end.line, _end.character, offset_encoding),
       severity = severity_lsp_to_vim(diagnostic.severity),
-      message = diagnostic.message
+      message = diagnostic.message,
+      user_data = {
+        lsp = {
+          code = diagnostic.code,
+          codeDescription = diagnostic.codeDescription,
+          tags = diagnostic.tags,
+          relatedInformation = diagnostic.relatedInformation,
+          data = diagnostic.data,
+        },
+      },
     }
   end, diagnostics)
 end
 
 ---@private
 local function diagnostic_vim_to_lsp(diagnostics)
   return vim.tbl_map(function(diagnostic)
-    return {
+    return vim.tbl_extend("error", {
       range = {
         start = {
           line = diagnostic.lnum,
@@ -123,7 +132,7 @@ local function diagnostic_vim_to_lsp(diagnostics)
       },
       severity = severity_vim_to_lsp(diagnostic.severity),
       message = diagnostic.message,
-    }
+    }, diagnostic.user_data and (diagnostic.user_data.lsp or {}) or {})
   end, diagnostics)
 end
 
diff --git a/test/functional/plugin/lsp/diagnostic_spec.lua b/test/functional/plugin/lsp/diagnostic_spec.lua
@@ -428,6 +428,32 @@ describe('vim.lsp.diagnostic', function()
         end)
       end)
     end)
+
+    it('maintains LSP information when translating diagnostics', function()
+      local result = exec_lua [[
+        local diagnostics = {
+          make_error("Error 1", 1, 1, 1, 5),
+        }
+
+        diagnostics[1].code = 42
+        diagnostics[1].tags = {"foo", "bar"}
+        diagnostics[1].data = "Hello world"
+
+        vim.lsp.diagnostic.on_publish_diagnostics(nil, {
+          uri = fake_uri,
+          diagnostics = diagnostics,
+        }, {client_id=1})
+
+        return {
+          vim.diagnostic.get(diagnostic_bufnr, {lnum=1})[1],
+          vim.lsp.diagnostic.get_line_diagnostics(diagnostic_bufnr, 1)[1],
+        }
+      ]]
+      eq({code = 42, tags = {"foo", "bar"}, data = "Hello world"}, result[1].user_data.lsp)
+      eq(42, result[2].code)
+      eq({"foo", "bar"}, result[2].tags)
+      eq("Hello world", result[2].data)
+    end)
   end)
 
   describe("vim.lsp.diagnostic.get_line_diagnostics", function()
