Fix signature help not working

Also fix markdown in completion item

Author: JohnnyMorganz

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Fixed
+
+- Fixed signature help not showing up
+- Fixed markdown in completion not working
+
 ## [0.4.0] - 2022-05-17
 
 ### Added

src/Protocol.hpp

@@ -648,14 +648,28 @@ enum struct CompletionItemKind
     TypeParameter = 25,
 };
 
+enum struct MarkupKind
+{
+    PlainText,
+    Markdown,
+};
+NLOHMANN_JSON_SERIALIZE_ENUM(MarkupKind, {{MarkupKind::PlainText, "plaintext"}, {MarkupKind::Markdown, "markdown"}});
+
+struct MarkupContent
+{
+    MarkupKind kind;
+    std::string value;
+};
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(MarkupContent, kind, value);
+
 struct CompletionItem
 {
     std::string label;
     std::optional<CompletionItemLabelDetails> labelDetails;
     std::optional<CompletionItemKind> kind;
     std::optional<std::vector<CompletionItemTag>> tags;
     std::optional<std::string> detail;
-    std::optional<std::string> documentation;
+    std::optional<MarkupContent> documentation;
     bool deprecated = false;
     bool preselect = false;
     std::optional<std::string> sortText;
@@ -692,20 +706,6 @@ struct HoverParams : TextDocumentPositionParams
 {
 };
 
-enum struct MarkupKind
-{
-    PlainText,
-    Markdown,
-};
-NLOHMANN_JSON_SERIALIZE_ENUM(MarkupKind, {{MarkupKind::PlainText, "plaintext"}, {MarkupKind::Markdown, "markdown"}});
-
-struct MarkupContent
-{
-    MarkupKind kind;
-    std::string value;
-};
-NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(MarkupContent, kind, value);
-
 struct Hover
 {
     MarkupContent contents;

src/Workspace.hpp

@@ -799,7 +799,7 @@ class WorkspaceFolder
             item.deprecated = entry.deprecated;
 
             if (entry.documentationSymbol)
-                item.documentation = printDocumentation(client->documentation, *entry.documentationSymbol);
+                item.documentation = {lsp::MarkupKind::Markdown, printDocumentation(client->documentation, *entry.documentationSymbol)};
 
             switch (entry.kind)
             {
@@ -1086,7 +1086,7 @@ class WorkspaceFolder
 
             // Create the whole label
             std::string label = types::toStringNamedFunction(module, ftv, candidate->func);
-            std::optional<lsp::MarkupContent> documentation;
+            lsp::MarkupContent documentation{lsp::MarkupKind::PlainText, ""};
 
             if (followedId->documentationSymbol)
                 documentation = {lsp::MarkupKind::Markdown, printDocumentation(client->documentation, *followedId->documentationSymbol)};
@@ -1107,17 +1107,19 @@ class WorkspaceFolder
                 }
 
                 std::string label;
+                lsp::MarkupContent parameterDocumentation{lsp::MarkupKind::PlainText, ""};
                 if (idx < ftv->argNames.size() && ftv->argNames[idx])
                 {
                     label = ftv->argNames[idx]->name + ": ";
                 }
                 label += Luau::toString(*it);
-                parameters.push_back(lsp::ParameterInformation{label});
+
+                parameters.push_back(lsp::ParameterInformation{label, parameterDocumentation});
                 it++;
                 idx++;
             }
 
-            signatures.push_back(lsp::SignatureInformation{label, std::nullopt, parameters});
+            signatures.push_back(lsp::SignatureInformation{label, documentation, parameters});
         };
 
         if (auto ftv = Luau::get<Luau::FunctionTypeVar>(followedId))

src/main.cpp

@@ -500,17 +500,21 @@ class LanguageServer
     }
 
     // TODO: can't type this as lsp::hover as it can return null
-    std::optional<lsp::Hover> hover(const lsp::HoverParams& params)
+    Response hover(const lsp::HoverParams& params)
     {
         auto workspace = findWorkspace(params.textDocument.uri);
-        return workspace->hover(params);
+        if (auto result = workspace->hover(params))
+            return *result;
+        return nullptr;
     }
 
     // TODO: can't type this as lsp::SignatureHelp as it can return null
-    std::optional<lsp::SignatureHelp> signatureHelp(const lsp::SignatureHelpParams& params)
+    Response signatureHelp(const lsp::SignatureHelpParams& params)
     {
         auto workspace = findWorkspace(params.textDocument.uri);
-        return workspace->signatureHelp(params);
+        if (auto result = workspace->signatureHelp(params))
+            return *result;
+        return nullptr;
     }
 
     Response gotoDefinition(const lsp::DefinitionParams& params)