noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Merge pull request #118598 from Finishxx/gdscript-lsp-color-bbcode-support

Browse Source 
GDScript LSP: Convert [color] BBCode to <span> HTML for capable clients
This commit is contained in:
Thaddeus Crews
2026-06-25 08:32:24 -05:00
parent fd98f8452a 9b0d85c3a0
commit 3089ceed8d
6 changed files with 110 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/gdscript/tests/test_lsp.h
+43 -31
View File
@@ -453,61 +453,73 @@ TEST_SUITE("[Modules][GDScript][LSP][Editor]") {
// the LSP client on documentation requests
// Basic formatting
CHECK_EQ(LSP::marked_documentation("[b]bold[/b]"), "**bold**");
CHECK_EQ(LSP::marked_documentation("[i]italic[/i]"), "*italic*");
CHECK_EQ(LSP::marked_documentation("[u]underline[/u]"), "__underline__");
CHECK_EQ(LSP::marked_documentation("[s]strikethrough[/s]"), "~~strikethrough~~");
CHECK_EQ(LSP::marked_documentation("[code]code[/code]"), "`code`");
CHECK_EQ(LSP::marked_documentation("[kbd]Ctrl + S[/kbd]"), "`Ctrl + S`");
CHECK_EQ(LSP::marked_documentation("[b]bold[/b]", {}), "**bold**");
CHECK_EQ(LSP::marked_documentation("[i]italic[/i]", {}), "*italic*");
CHECK_EQ(LSP::marked_documentation("[u]underline[/u]", {}), "__underline__");
CHECK_EQ(LSP::marked_documentation("[s]strikethrough[/s]", {}), "~~strikethrough~~");
CHECK_EQ(LSP::marked_documentation("[code]code[/code]", {}), "`code`");
CHECK_EQ(LSP::marked_documentation("[kbd]Ctrl + S[/kbd]", {}), "`Ctrl + S`");
// Line breaks. We insert paragraphs for [br] because the BBCode to
// markdown conversion function simply makes the conversion line-wise and
// we don't distinguish markdown inline elements and blocks.
CHECK_EQ(LSP::marked_documentation("Line1[br]Line2"), "Line1\n\nLine2");
CHECK_EQ(LSP::marked_documentation("Line1[br]Line2", {}), "Line1\n\nLine2");
// These tags (center, color, font) aren't supported in markdown and should be stripped.
CHECK_EQ(LSP::marked_documentation("[center]Centered text[/center]"), "Centered text");
CHECK_EQ(LSP::marked_documentation("[color=red]red text[/color]"), "red text");
CHECK_EQ(LSP::marked_documentation("[font=Arial]Arial text[/font]"), "Arial text");
// These tags (center, font) aren't supported in markdown and should be stripped.
CHECK_EQ(LSP::marked_documentation("[center]Centered text[/center]", {}), "Centered text");
CHECK_EQ(LSP::marked_documentation("[font=Arial]Arial text[/font]", {}), "Arial text");
// [color] for incapable clients is stripped
CHECK_EQ(LSP::marked_documentation("[color=red]red text[/color]", {}), "red text");
// [color] tag for capable clients is converted to span
HashSet<String> span_allowed_tags = { "span" };
CHECK_EQ(LSP::marked_documentation("[color=red]red text[/color]", span_allowed_tags), "<span style=\"color:#ff0000\">red text</span>");
CHECK_EQ(LSP::marked_documentation("[color=#ff0000]red text[/color]", span_allowed_tags), "<span style=\"color:#ff0000\">red text</span>");
CHECK_EQ(LSP::marked_documentation("[color=#ff0000ff]red text[/color]", span_allowed_tags), "<span style=\"color:#ff0000ff\">red text</span>");
CHECK_EQ(LSP::marked_documentation("[color=red]r[/color] and [color=blue]b[/color]", span_allowed_tags), "<span style=\"color:#ff0000\">r</span> and <span style=\"color:#0000ff\">b</span>");
CHECK_EQ(LSP::marked_documentation("[color=lobster]invalid color name[/color]", span_allowed_tags), "invalid color name");
CHECK_EQ(LSP::marked_documentation("[color=#zzzzzz]invalid color hex[/color]", span_allowed_tags), "invalid color hex");
CHECK_EQ(LSP::marked_documentation("[color=#ff0000\"> <script>malicious code</script>]no escaping[/color]", span_allowed_tags), "no escaping");
// The following tests are for all the link patterns specific to Godot's built-in docs that we render as inline code.
CHECK_EQ(LSP::marked_documentation("Class link: [Node2D], [Sprite2D]"), "Class link: `Node2D`, `Sprite2D`");
CHECK_EQ(LSP::marked_documentation("Single class [RigidBody2D]"), "Single class `RigidBody2D`");
CHECK_EQ(LSP::marked_documentation("[method Node2D.set_position]"), "`Node2D.set_position`");
CHECK_EQ(LSP::marked_documentation("[member Node2D.position]"), "`Node2D.position`");
CHECK_EQ(LSP::marked_documentation("[signal Node.ready]"), "`Node.ready`");
CHECK_EQ(LSP::marked_documentation("[constant Color.RED]"), "`Color.RED`");
CHECK_EQ(LSP::marked_documentation("[enum Node.ProcessMode]"), "`Node.ProcessMode`");
CHECK_EQ(LSP::marked_documentation("[annotation @GDScript.@export]"), "`@GDScript.@export`");
CHECK_EQ(LSP::marked_documentation("[constructor Vector2.Vector2]"), "`Vector2.Vector2`");
CHECK_EQ(LSP::marked_documentation("[operator Vector2.operator +]"), "`Vector2.operator +`");
CHECK_EQ(LSP::marked_documentation("[theme_item Button.font]"), "`Button.font`");
CHECK_EQ(LSP::marked_documentation("[param delta]"), "`delta`");
CHECK_EQ(LSP::marked_documentation("Class link: [Node2D], [Sprite2D]", {}), "Class link: `Node2D`, `Sprite2D`");
CHECK_EQ(LSP::marked_documentation("Single class [RigidBody2D]", {}), "Single class `RigidBody2D`");
CHECK_EQ(LSP::marked_documentation("[method Node2D.set_position]", {}), "`Node2D.set_position`");
CHECK_EQ(LSP::marked_documentation("[member Node2D.position]", {}), "`Node2D.position`");
CHECK_EQ(LSP::marked_documentation("[signal Node.ready]", {}), "`Node.ready`");
CHECK_EQ(LSP::marked_documentation("[constant Color.RED]", {}), "`Color.RED`");
CHECK_EQ(LSP::marked_documentation("[enum Node.ProcessMode]", {}), "`Node.ProcessMode`");
CHECK_EQ(LSP::marked_documentation("[annotation @GDScript.@export]", {}), "`@GDScript.@export`");
CHECK_EQ(LSP::marked_documentation("[constructor Vector2.Vector2]", {}), "`Vector2.Vector2`");
CHECK_EQ(LSP::marked_documentation("[operator Vector2.operator +]", {}), "`Vector2.operator +`");
CHECK_EQ(LSP::marked_documentation("[theme_item Button.font]", {}), "`Button.font`");
CHECK_EQ(LSP::marked_documentation("[param delta]", {}), "`delta`");
// Markdown links
CHECK_EQ(LSP::marked_documentation("[url=https://godotengine.org]link to Godot Engine[/url]"),
CHECK_EQ(LSP::marked_documentation("[url=https://godotengine.org]link to Godot Engine[/url]", {}),
"[link to Godot Engine](https://godotengine.org)");
CHECK_EQ(LSP::marked_documentation("[url]https://godotengine.org/[/url]"),
CHECK_EQ(LSP::marked_documentation("[url]https://godotengine.org/[/url]", {}),
"[https://godotengine.org/](https://godotengine.org/)");
// Code listings
CHECK_EQ(LSP::marked_documentation("[codeblock]\nfunc test():\n print(\"Hello, Godot!\")\n[/codeblock]"),
CHECK_EQ(LSP::marked_documentation("[codeblock]\nfunc test():\n print(\"Hello, Godot!\")\n[/codeblock]", {}),
"```gdscript\nfunc test():\n print(\"Hello, Godot!\")\n```");
CHECK_EQ(LSP::marked_documentation("[codeblock lang=csharp]\npublic void Test()\n{\n GD.Print(\"Hello, Godot!\");\n}\n[/codeblock]"),
CHECK_EQ(LSP::marked_documentation("[codeblock lang=csharp]\npublic void Test()\n{\n GD.Print(\"Hello, Godot!\");\n}\n[/codeblock]", {}),
"```csharp\npublic void Test()\n{\n GD.Print(\"Hello, Godot!\");\n}\n```");
// Code listings with multiple languages (the codeblocks tag is used in the built-in reference)
// When [codeblocks] is used, we only convert the [gdscript] tag to a code block like the built-in editor.
// NOTE: There is always a GDScript code listing in the built-in class reference.
CHECK_EQ(LSP::marked_documentation("[codeblocks]\n[gdscript]\nprint(hash(\"a\")) # Prints 177670\n[/gdscript]\n[csharp]\nGD.Print(GD.Hash(\"a\")); // Prints 177670\n[/csharp]\n[/codeblocks]"),
CHECK_EQ(LSP::marked_documentation("[codeblocks]\n[gdscript]\nprint(hash(\"a\")) # Prints 177670\n[/gdscript]\n[csharp]\nGD.Print(GD.Hash(\"a\")); // Prints 177670\n[/csharp]\n[/codeblocks]", {}),
"```gdscript\nprint(hash(\"a\")) # Prints 177670\n```\n");
// lb and rb are used to insert literal square brackets in markdown.
CHECK_EQ(LSP::marked_documentation("[lb]literal brackets[rb]"), "\\[literal brackets\\]");
CHECK_EQ(LSP::marked_documentation("[lb]literal[rb] with [ClassName]"), "\\[literal\\] with `ClassName`");
CHECK_EQ(LSP::marked_documentation("[lb]literal brackets[rb]", {}), "\\[literal brackets\\]");
CHECK_EQ(LSP::marked_documentation("[lb]literal[rb] with [ClassName]", {}), "\\[literal\\] with `ClassName`");
// We have to be careful that different patterns don't conflict with each
// other, especially with urls that use brackets in markdown.
CHECK_EQ(LSP::marked_documentation("Class [Sprite2D] with [url=https://godotengine.org]link[/url]"),
CHECK_EQ(LSP::marked_documentation("Class [Sprite2D] with [url=https://godotengine.org]link[/url]", {}),
"Class `Sprite2D` with [link](https://godotengine.org)");
}
TEST_CASE("get_symbol_name_under_position") {