Add localized mod documentation with syntax highlighting
This commit is contained in:
cthangover committed
1 parent
7ae31f180c
commit
55a3e9b157
24 files changed
+1255
-1
No files matched your search
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"name": "Mod documentation test",
|
||||
"sources": ["src/*.cs"]
|
||||
}
|
||||
@@ -0,0 +1,188 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using Cthangover.Core.Bootstrap;
|
||||
using Cthangover.Core.Localization;
|
||||
using Cthangover.Core.Mods;
|
||||
using Cthangover.Core.UI.Menu;
|
||||
using Cthangover.Core.Utils;
|
||||
using Cthangover.Mods.Interface.Menu;
|
||||
using Cthangover.Mods.Interface.View;
|
||||
using Godot;
|
||||
|
||||
namespace Mods.ModManager.DocumentationTest
|
||||
{
|
||||
/// <summary>Opens music_pack through the hub and exercises language selection on the actual page.</summary>
|
||||
public partial class DocumentationTestDriver : Node
|
||||
{
|
||||
private double elapsed;
|
||||
private double stepAt;
|
||||
private int step;
|
||||
private int passed;
|
||||
private bool done;
|
||||
private string originalLocale;
|
||||
private ModHubScreen hub;
|
||||
private ModManagerScreen manager;
|
||||
private ModDetailView detail;
|
||||
|
||||
public override void _Process(double delta)
|
||||
{
|
||||
if (done)
|
||||
return;
|
||||
elapsed += delta;
|
||||
if (elapsed > 60)
|
||||
{
|
||||
Finish("timeout at step " + step);
|
||||
return;
|
||||
}
|
||||
if (elapsed - stepAt < 0.6)
|
||||
return;
|
||||
stepAt = elapsed;
|
||||
try
|
||||
{
|
||||
RunStep();
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Finish(ex.ToString());
|
||||
}
|
||||
}
|
||||
|
||||
private void RunStep()
|
||||
{
|
||||
switch (step)
|
||||
{
|
||||
case 0:
|
||||
if (!Boot.IsReady)
|
||||
return;
|
||||
if (GetTree().CurrentScene?.FindChild("LauncherPlay", true, false) is Button launcherPlay)
|
||||
{
|
||||
launcherPlay.EmitSignal(BaseButton.SignalName.Pressed);
|
||||
return;
|
||||
}
|
||||
if (GetTree().CurrentScene?.FindChild("play", true, false) is not Button)
|
||||
return;
|
||||
originalLocale = TranslationServer.GetLocale();
|
||||
LocaleLoader.LoadLocale("ru");
|
||||
var entry = MenuRegistry.GetButtonById("mods_hub");
|
||||
hub = MenuBuilder.OpenScene((Control)GetTree().CurrentScene, entry.ScenePath, "mods_hub") as ModHubScreen;
|
||||
Check(hub != null, "hub opens");
|
||||
break;
|
||||
case 1:
|
||||
manager = hub.FindChildren("*", "", true, false).OfType<ModManagerScreen>().First();
|
||||
manager.SetSearch("music_pack");
|
||||
break;
|
||||
case 2:
|
||||
var card = hub.FindChildren("*", "", true, false).OfType<ModCard>().First(IsVisibleCard);
|
||||
card.EmitSignal(Control.SignalName.GuiInput, new InputEventMouseButton { ButtonIndex = MouseButton.Left, Pressed = true });
|
||||
break;
|
||||
case 3:
|
||||
detail = hub.FindChildren("*", "", true, false).OfType<ModDetailView>().First(IsVisibleDetail);
|
||||
Check(Body().GetParsedText().Contains("музыка для вашей игры"), "automatic Russian document");
|
||||
Check(Body().GetContentHeight() > 600, "long document lays out");
|
||||
var codeFont = Body().GetThemeFont("mono_font");
|
||||
Check(codeFont.HasChar('└') && codeFont.HasChar('─') && codeFont.HasChar('├'), "bundled monospace font covers tree glyphs");
|
||||
Check(ModDocumentation.Discover(ModRegistry.Instance.AllDiscoveredMods["music_pack"].FileProvider).Count == 2, "two bundled languages");
|
||||
Shot("music_pack_ru");
|
||||
SelectLanguage("EN");
|
||||
break;
|
||||
case 4:
|
||||
Check(Body().GetParsedText().Contains("a soundtrack for your game"), "manual English document");
|
||||
Check(!Body().GetParsedText().Contains(TranslationServer.Translate("mod_manager/docs_image_unavailable").ToString()), "bundled image resolves");
|
||||
Shot("music_pack_en");
|
||||
ScrollToText("// Add the dependency");
|
||||
break;
|
||||
case 5:
|
||||
Shot("music_pack_code_en");
|
||||
var languages = Languages();
|
||||
languages.Select(0);
|
||||
languages.EmitSignal(OptionButton.SignalName.ItemSelected, 0L);
|
||||
LocaleLoader.LoadLocale("ja");
|
||||
break;
|
||||
case 6:
|
||||
Check(Body().GetParsedText().Contains("a soundtrack for your game"), "missing Japanese falls back to English after locale change");
|
||||
Check(detail.GetNode<Label>("Scroll/Content/DocumentationBox/Source").Text.Contains("EN"), "actual fallback language is visible");
|
||||
manager.CloseDetail();
|
||||
manager.SetSearch("audio_base");
|
||||
break;
|
||||
case 7:
|
||||
var legacyCard = hub.FindChildren("*", "", true, false).OfType<ModCard>().First(IsVisibleCard);
|
||||
legacyCard.EmitSignal(Control.SignalName.GuiInput, new InputEventMouseButton { ButtonIndex = MouseButton.Left, Pressed = true });
|
||||
break;
|
||||
case 8:
|
||||
Check(!detail.GetNode<Control>("Scroll/Content/DocumentationBox").Visible, "legacy mod keeps manifest description");
|
||||
Check(!string.IsNullOrWhiteSpace(detail.GetNode<Label>("Scroll/Content/DescriptionBox/Text").Text), "legacy description remains readable");
|
||||
Finish(null);
|
||||
break;
|
||||
}
|
||||
step++;
|
||||
}
|
||||
|
||||
private ModMarkdownView Body() => detail.GetNode<ModMarkdownView>("Scroll/Content/DocumentationBox/Body");
|
||||
private OptionButton Languages() => detail.GetNode<OptionButton>("Scroll/Content/DocumentationBox/Header/Languages");
|
||||
private static bool IsVisibleCard(ModCard card) => card.IsVisibleInTree();
|
||||
private static bool IsVisibleDetail(ModDetailView page) => page.IsVisibleInTree();
|
||||
private static bool IsScreenshotArg(string arg) => arg.StartsWith("--shots=");
|
||||
|
||||
private void ScrollToText(string needle)
|
||||
{
|
||||
var text = Body().GetParsedText();
|
||||
var offset = text.IndexOf(needle, StringComparison.Ordinal);
|
||||
Check(offset >= 0, "code example remains literal and selectable");
|
||||
var paragraph = 0;
|
||||
for (var i = 0; i < offset; i++)
|
||||
if (text[i] == '\n')
|
||||
paragraph++;
|
||||
var scroll = detail.GetNode<ScrollContainer>("Scroll");
|
||||
var content = detail.GetNode<Control>("Scroll/Content");
|
||||
scroll.ScrollVertical = (int)(Body().GlobalPosition.Y - content.GlobalPosition.Y + Body().GetParagraphOffset(paragraph)) - 32;
|
||||
}
|
||||
|
||||
private void SelectLanguage(string language)
|
||||
{
|
||||
var languages = Languages();
|
||||
for (var i = 0; i < languages.ItemCount; i++)
|
||||
if (languages.GetItemText(i) == language)
|
||||
{
|
||||
languages.Select(i);
|
||||
languages.EmitSignal(OptionButton.SignalName.ItemSelected, (long)i);
|
||||
return;
|
||||
}
|
||||
throw new InvalidOperationException("Missing language " + language);
|
||||
}
|
||||
|
||||
private void Check(bool ok, string label)
|
||||
{
|
||||
if (!ok)
|
||||
throw new InvalidOperationException(label);
|
||||
passed++;
|
||||
GameLogger.Log("TEST", "Documentation: [OK] " + label);
|
||||
}
|
||||
|
||||
private void Shot(string name)
|
||||
{
|
||||
var arg = OS.GetCmdlineUserArgs().FirstOrDefault(IsScreenshotArg);
|
||||
if (arg == null || DisplayServer.GetName() == "headless")
|
||||
return;
|
||||
var directory = ProjectSettings.GlobalizePath(arg.Substring(8));
|
||||
Directory.CreateDirectory(directory);
|
||||
ViewportCapture.SavePng(GetViewport(), Path.Combine(directory, name + ".png"));
|
||||
}
|
||||
|
||||
private async void Finish(string failure)
|
||||
{
|
||||
if (done)
|
||||
return;
|
||||
done = true;
|
||||
hub?.QueueFree();
|
||||
if (originalLocale != null)
|
||||
LocaleLoader.LoadLocale(originalLocale);
|
||||
await ToSignal(GetTree(), SceneTree.SignalName.ProcessFrame);
|
||||
await ToSignal(GetTree(), SceneTree.SignalName.ProcessFrame);
|
||||
if (failure != null)
|
||||
GameLogger.Log("TEST", "Documentation: " + failure, LogLevel.Error);
|
||||
GameLogger.Log("TEST", $"[TEST_RESULT] name=mod_documentation passed={passed} failed={(failure == null ? 0 : 1)}");
|
||||
GetTree().Quit(failure == null ? 0 : 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
using Cthangover.Core.Mods;
|
||||
|
||||
namespace Mods.ModManager.DocumentationTest
|
||||
{
|
||||
/// <summary>Mounting this suite explicitly enables the documentation UI walk-through.</summary>
|
||||
public class DocumentationTestInitializer : IModInitializer
|
||||
{
|
||||
private static bool queued;
|
||||
public void OnModLoaded(string modId) { }
|
||||
public void OnModResourcesReady()
|
||||
{
|
||||
if (queued)
|
||||
return;
|
||||
queued = true;
|
||||
ModRoot.AddDeferred(new DocumentationTestDriver());
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user