feat: include more data in diagnostic (#52)

Author: mhanberg

lib/credo_language_server.ex

@@ -27,6 +27,7 @@ defmodule CredoLanguageServer do
     CodeActionContext,
     CodeActionOptions,
     CodeActionParams,
+    CodeDescription,
     Diagnostic,
     DidOpenTextDocumentParams,
     InitializeParams,
@@ -384,13 +385,13 @@ defmodule CredoLanguageServer do
         },
         severity: category_to_severity(issue.category),
         data: %{check: issue.check, file: issue.filename},
-        message: """
-        #{issue.message}
-
-        ## Explanation
-
-        #{CredoLanguageServer.Runtime.call(lsp.assigns.runtime, {issue.check, :explanations, []})[:check]}
-        """
+        source: "credo",
+        code: Macro.to_string(issue.check),
+        code_description: %CodeDescription{
+          href:
+            "https://hexdocs.pm/credo/#{Macro.to_string(issue.check)}.html"
+        },
+        message: issue.message
       }
 
       Diagnostics.put(

test/credo_language_server_test.exs

@@ -147,7 +147,17 @@ defmodule CredoLanguageServerTest do
       assert_notification "textDocument/publishDiagnostics",
                           %{
                             "uri" => ^uri,
-                            "diagnostics" => [%{"severity" => 3}]
+                            "diagnostics" => [
+                              %{
+                                "source" => "credo",
+                                "code" => "Credo.Check.Readability.ModuleDoc",
+                                "codeDescription" => %{
+                                  "href" =>
+                                    "https://hexdocs.pm/credo/Credo.Check.Readability.ModuleDoc.html"
+                                },
+                                "severity" => 3
+                              }
+                            ]
                           }
     end