fix: use MarkupContent respecting client markdown capabilities for all LSP documentation fields

Catglobe.CgScript.EditorSupport.Lsp.Tests/CompletionObjectTests.cs

@@ -0,0 +1,139 @@
+using Catglobe.CgScript.EditorSupport.Lsp.Definitions;
+using Catglobe.CgScript.EditorSupport.Lsp.Handlers;
+using Microsoft.VisualStudio.LanguageServer.Protocol;
+
+namespace Catglobe.CgScript.EditorSupport.Lsp.Tests;
+
+/// <summary>
+/// Verifies that object type completion items expose their documentation respecting
+/// the client's declared <c>completionItem.documentationFormat</c> capability.
+/// </summary>
+public class CompletionObjectTests
+{
+   private sealed class TestDefinitionLoader : DefinitionLoader
+   {
+      public TestDefinitionLoader(Dictionary<string, ObjectDefinition> objects)
+         : base(
+            functions:       [],
+            objects:         objects,
+            constants:       [],
+            globalVariables: new Dictionary<string, string>(),
+            enums:           [])
+      { }
+   }
+
+   private static CompletionItem[] GetCompletions(
+      Dictionary<string, ObjectDefinition> objects,
+      string             prefix         = "",
+      InitializeParams?  initializeParams = null)
+   {
+      var uri         = "file:///test.cgs";
+      var definitions = new TestDefinitionLoader(objects);
+      var store       = new DocumentStore(definitions);
+      store.Update(uri, prefix);
+      var target = new CgScriptLanguageTarget(store, definitions);
+      target.Initialize(initializeParams);
+
+      var p = new CompletionParams
+      {
+         TextDocument = new TextDocumentIdentifier { Uri = new Uri(uri) },
+         Position     = new Position(0, prefix.Length),
+      };
+      var result = target.OnCompletion(p);
+      if (result is null) return [];
+      if (result.Value.TryGetFirst(out var arr))  return arr  ?? [];
+      if (result.Value.TryGetSecond(out var list)) return list?.Items ?? [];
+      return [];
+   }
+
+   private static InitializeParams MarkdownCapabilityParams() => new InitializeParams
+   {
+      Capabilities = new ClientCapabilities
+      {
+         TextDocument = new TextDocumentClientCapabilities
+         {
+            Completion = new CompletionSetting
+            {
+               CompletionItem = new CompletionItemSetting
+               {
+                  DocumentationFormat = [MarkupKind.Markdown],
+               },
+            },
+         },
+      },
+   };
+
+   // ── Without markdown capability: PlainText ────────────────────────────────
+
+   [Fact]
+   public void ObjectCompletion_WithoutMarkdownCapability_Documentation_IsPlainText()
+   {
+      var objects = new Dictionary<string, ObjectDefinition>
+      {
+         ["MyObject"] = new ObjectDefinition("My **object** doc", [], [], [], []),
+      };
+
+      var items = GetCompletions(objects, prefix: "MyObject"); // no initializeParams → no markdown capability
+
+      var item = items.FirstOrDefault(i => i.Label == "MyObject");
+      Assert.NotNull(item);
+      Assert.True(item.Documentation.HasValue);
+      Assert.True(item.Documentation.Value.TryGetSecond(out var markup));
+      Assert.Equal(MarkupKind.PlainText, markup?.Kind);
+   }
+
+   [Fact]
+   public void ObjectCompletion_WithoutMarkdownCapability_Documentation_StripsMarkdown()
+   {
+      var objects = new Dictionary<string, ObjectDefinition>
+      {
+         ["MyObject"] = new ObjectDefinition("My **object** doc", [], [], [], []),
+      };
+
+      var items = GetCompletions(objects, prefix: "MyObject");
+
+      var item = items.FirstOrDefault(i => i.Label == "MyObject");
+      Assert.NotNull(item);
+      Assert.True(item.Documentation.HasValue);
+      Assert.True(item.Documentation.Value.TryGetSecond(out var markup));
+      Assert.Equal("My object doc", markup?.Value);
+   }
+
+   // ── With markdown capability: Markdown ────────────────────────────────────
+
+   [Fact]
+   public void ObjectCompletion_WithMarkdownCapability_Documentation_IsMarkdown()
+   {
+      var objects = new Dictionary<string, ObjectDefinition>
+      {
+         ["MyObject"] = new ObjectDefinition("My **object** doc", [], [], [], []),
+      };
+
+      var items = GetCompletions(objects, prefix: "MyObject", initializeParams: MarkdownCapabilityParams());
+
+      var item = items.FirstOrDefault(i => i.Label == "MyObject");
+      Assert.NotNull(item);
+      Assert.True(item.Documentation.HasValue);
+      Assert.True(item.Documentation.Value.TryGetSecond(out var markup));
+      Assert.Equal(MarkupKind.Markdown, markup?.Kind);
+      Assert.Equal("My **object** doc", markup?.Value);
+   }
+
+   [Fact]
+   public void ObjectCompletion_NullDoc_Documentation_IsPlainTextWithEmptyValue()
+   {
+      var objects = new Dictionary<string, ObjectDefinition>
+      {
+         ["MyObject"] = new ObjectDefinition("", [], [], [], []),
+      };
+
+      var items = GetCompletions(objects, prefix: "MyObject");
+
+      var item = items.FirstOrDefault(i => i.Label == "MyObject");
+      Assert.NotNull(item);
+      Assert.True(item.Documentation.HasValue);
+      Assert.True(item.Documentation.Value.TryGetSecond(out var markup));
+      Assert.Equal(MarkupKind.PlainText, markup?.Kind);
+      Assert.Equal(string.Empty, markup?.Value);
+   }
+}