feat: support plain-text help documentation

Author: Elektryk-Andrzej

Code/Plugin/Commands/HelpSystem/DocsCommand.cs

@@ -127,6 +127,6 @@ private static void MakeDocFile(string type, StringBuilder content)
         if (!Directory.Exists(folder)) Directory.CreateDirectory(folder);
 
         using var sw = File.CreateText(Path.Combine(folder, $"#{type}.txt"));
-        sw.Write(content.ToString());
+        sw.Write(DocsProvider.Render(content.ToString(), DocsFormat.PlainText));
     }
 }

Code/Plugin/Commands/HelpSystem/DocsFormat.cs

@@ -0,0 +1,7 @@
+namespace SER.Code.Plugin.Commands.HelpSystem;
+
+public enum DocsFormat
+{
+    Markdown,
+    PlainText
+}

Code/Plugin/Commands/HelpSystem/DocsProvider.cs

@@ -39,6 +39,9 @@ private static string BulletList(IEnumerable<string> items) =>
     private static string Heading(string title, int level = 2) =>
         $"{new string('#', level)} {title}";
 
+    public static string Render(string content, DocsFormat format) =>
+        format == DocsFormat.Markdown ? content : RenderPlainText(content);
+
     public static readonly Dictionary<HelpOption, Func<string>> GeneralOptions = new()
     {
         [HelpOption.Start] = GetStartHelpPage,
@@ -52,7 +55,18 @@ private static string Heading(string title, int level = 2) =>
         [HelpOption.Keywords] = GetKeywordHelpPage
     };
 
-    public static bool GetGeneralOutput(ArraySegment<string> args, ICommandSender sender, out string response)
+    public static bool GetGeneralOutput(
+        ArraySegment<string> args,
+        ICommandSender sender,
+        out string response,
+        DocsFormat format = DocsFormat.Markdown)
+    {
+        var result = GetGeneralOutputMarkdown(args, sender, out var markdownResponse);
+        response = Render(markdownResponse, format);
+        return result;
+    }
+
+    private static bool GetGeneralOutputMarkdown(ArraySegment<string> args, ICommandSender sender, out string response)
     {
         var arg = args.Array?[args.Offset].ToLowerInvariant() 
                   ?? throw new CoreInvariantException("Help arguments were provided in an invalid format.");
@@ -141,7 +155,12 @@ public static bool GetGeneralOutput(ArraySegment<string> args, ICommandSender se
         return false;
     }
 
-    public static string GetOptionsList()
+    public static string GetOptionsList(DocsFormat format = DocsFormat.Markdown)
+    {
+        return Render(GetOptionsListMarkdown(), format);
+    }
+
+    private static string GetOptionsListMarkdown()
     {
         return $"""
                 # SER help
@@ -338,7 +357,7 @@ public static string GetKeywordInfo(IKeywordContext keyword)
     public static string GetKeywordHelpPage()
     {
         return
-            """
+            $"""
             Keywords alter how the script behaves, not by changing someones role, but the internal script execution.
             They can range from simple things from stopping the script to handling advanced logic.
 
@@ -1028,6 +1047,61 @@ public static bool GetPropertiesForType(string typeName, out string response)
         return true;
     }
 
+    private static string RenderPlainText(string content)
+    {
+        var lines = content.Replace("\r\n", "\n").Replace('\r', '\n').Split('\n');
+        var output = new StringBuilder();
+        var inCodeBlock = false;
+
+        for (var index = 0; index < lines.Length; index++)
+        {
+            var line = lines[index];
+            var trimmed = line.Trim();
+
+            if (trimmed.StartsWith("```", StringComparison.Ordinal))
+            {
+                inCodeBlock = !inCodeBlock;
+                continue;
+            }
+
+            if (inCodeBlock)
+            {
+                output.AppendLine(line);
+                continue;
+            }
+
+            if (trimmed.Length == 0)
+            {
+                output.AppendLine();
+                continue;
+            }
+
+            var heading = trimmed.TakeWhile(c => c == '#').Count();
+            if (heading is > 0 and <= 6 && trimmed.Length > heading && char.IsWhiteSpace(trimmed[heading]))
+            {
+                var title = StripInlineMarkdown(trimmed[(heading + 1)..].Trim());
+                output.AppendLine(title);
+                output.AppendLine(new string(heading == 1 ? '=' : '-', Math.Max(3, title.Length)));
+                continue;
+            }
+
+            output.AppendLine(StripInlineMarkdown(line));
+        }
+
+        return output.ToString().TrimEnd();
+    }
+
+    private static string StripInlineMarkdown(string line)
+    {
+        line = line.Replace("\\`", "`");
+        line = System.Text.RegularExpressions.Regex.Replace(line, @"`([^`]*)`", "$1");
+        line = System.Text.RegularExpressions.Regex.Replace(line, @"\[([^\]]+)\]\([^\)]+\)", "$1");
+        line = line.Replace("**", string.Empty).Replace("__", string.Empty);
+        line = System.Text.RegularExpressions.Regex.Replace(line, @"(?<!\w)[*_](.*?)[*_](?!\w)", "$1");
+        line = System.Text.RegularExpressions.Regex.Replace(line, @"^\s*>\s?", "");
+        return line;
+    }
+
     // ai
     public static bool GetPropertiesAdvanced(
         ArraySegment<string> args,

Code/Plugin/Commands/HelpSystem/HelpCommand.cs

@@ -14,10 +14,10 @@ public bool Execute(ArraySegment<string> arguments, ICommandSender sender, out s
     {
         if (arguments.Count > 0)
         {
-            return DocsProvider.GetGeneralOutput(arguments, sender, out response);
+            return DocsProvider.GetGeneralOutput(arguments, sender, out response, DocsFormat.PlainText);
         }
 
-        response = DocsProvider.GetOptionsList();
+        response = DocsProvider.GetOptionsList(DocsFormat.PlainText);
         return true;
     }
 }