Refactor Markdown Rendering and Improve Performance

- Replaced legacy string-based Markdown rendering with a modern Markdig-based renderer in MarkdownRenderer.cs for improved performance and reduced VT escape sequence issues.
- Removed unused legacy rendering code and streamlined the Render method.
- Updated Rows class to use an empty array initializer.
- Enhanced StandardRenderer to utilize StringBuilder pooling for better memory management.
- Refactored TextMateProcessor to support cancellation tokens and progress reporting in batch processing methods.
- Updated TokenProcessor to handle escaping of markup characters and improved debugging capabilities.
- Added comprehensive unit tests for StandardRenderer, TextMateProcessor, and TokenProcessor to ensure functionality and performance.
- Cleaned up CacheManager tests to verify caching behavior and grammar retrieval.
- Updated project file to generate documentation.

Author: exptprua@perstorp.com

Module/PSTextMate.psd1

@@ -1,6 +1,6 @@
 @{
     RootModule           = 'PSTextMate.dll'
-    ModuleVersion        = '0.0.3'
+    ModuleVersion        = '0.1.0'
     GUID                 = '5ba21f1d-5ca4-49df-9a07-a2ad379feb00'
     Author               = 'trackd'
     CompanyName          = 'trackd'

build.ps1

@@ -36,7 +36,7 @@ Get-ChildItem -Path (Join-Path -Path $outputfolder -ChildPath 'runtimes' | Join-
 Get-ChildItem -Path (Join-Path -Path $outputfolder -ChildPath 'runtimes' | Join-Path -ChildPath 'linux-x64' | Join-Path -ChildPath 'native') -Filter *.so | Copy-Item -Destination $moduleLibFolder -Force
 Move-Item (Join-Path -Path $outputfolder -ChildPath 'PSTextMate.dll') -Destination (Split-Path $moduleLibFolder) -Force
 Get-ChildItem -Path $outputfolder -File |
-    Where-Object { -Not $_.Name.StartsWith('System.Text') -And $_.Extension -notin '.json','.pdb' } |
+    Where-Object { -Not $_.Name.StartsWith('System.Text') -And $_.Extension -notin '.json','.pdb','.xml' } |
         Move-Item -Destination $moduleLibFolder -Force
 
 Pop-Location

src/Cmdlets/DebugCmdlets.cs

@@ -11,10 +11,14 @@ namespace PwshSpectreConsole.TextMate.Cmdlets;
 /// Provides detailed diagnostic information for troubleshooting rendering issues.
 /// </summary>
 [Cmdlet(VerbsDiagnostic.Debug, "TextMate", DefaultParameterSetName = "String")]
+[OutputType(typeof(Test.TextMateDebug))]
 public sealed class DebugTextMateCmdlet : PSCmdlet
 {
     private readonly List<string> _inputObjectBuffer = new();
 
+    /// <summary>
+    /// String content to debug.
+    /// </summary>
     [Parameter(
         Mandatory = true,
         ValueFromPipeline = true,
@@ -23,6 +27,9 @@ public sealed class DebugTextMateCmdlet : PSCmdlet
     [AllowEmptyString]
     public string InputObject { get; set; } = null!;
 
+    /// <summary>
+    /// Path to file to debug.
+    /// </summary>
     [Parameter(
         Mandatory = true,
         ValueFromPipelineByPropertyName = true,
@@ -33,15 +40,24 @@ public sealed class DebugTextMateCmdlet : PSCmdlet
     [Alias("FullName")]
     public string Path { get; set; } = null!;
 
+    /// <summary>
+    /// TextMate language ID (default: 'powershell').
+    /// </summary>
     [Parameter(
         ParameterSetName = "String"
     )]
     [ValidateSet(typeof(TextMateLanguages))]
     public string Language { get; set; } = "powershell";
 
+    /// <summary>
+    /// Color theme for debug output (default: Dark).
+    /// </summary>
     [Parameter()]
     public ThemeName Theme { get; set; } = ThemeName.Dark;
 
+    /// <summary>
+    /// Override file extension for language detection.
+    /// </summary>
     [Parameter(
         ParameterSetName = "Path"
     )]
@@ -50,6 +66,9 @@ public sealed class DebugTextMateCmdlet : PSCmdlet
     [Alias("As")]
     public string ExtensionOverride { get; set; } = null!;
 
+    /// <summary>
+    /// Processes each input record from the pipeline.
+    /// </summary>
     protected override void ProcessRecord()
     {
         if (ParameterSetName == "String" && InputObject is not null)
@@ -58,6 +77,9 @@ protected override void ProcessRecord()
         }
     }
 
+    /// <summary>
+    /// Finalizes processing and outputs debug information.
+    /// </summary>
     protected override void EndProcessing()
     {
         try
@@ -98,33 +120,52 @@ protected override void EndProcessing()
 /// Cmdlet for debugging individual TextMate tokens and their properties.
 /// Provides low-level token analysis for detailed syntax highlighting inspection.
 /// </summary>
+[OutputType(typeof(Core.TokenDebugInfo))]
 [Cmdlet(VerbsDiagnostic.Debug, "TextMateTokens", DefaultParameterSetName = "String")]
 public sealed class DebugTextMateTokensCmdlet : PSCmdlet
 {
     private readonly List<string> _inputObjectBuffer = new();
 
+    /// <summary>
+    /// String content to analyze tokens from.
+    /// </summary>
     [Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = "String")]
     [AllowEmptyString]
     public string InputObject { get; set; } = null!;
 
+    /// <summary>
+    /// Path to file to analyze tokens from.
+    /// </summary>
     [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = "Path", Position = 0)]
     [ValidateNotNullOrEmpty]
     [Alias("FullName")]
     public string Path { get; set; } = null!;
 
+    /// <summary>
+    /// TextMate language ID (default: 'powershell').
+    /// </summary>
     [Parameter(ParameterSetName = "String")]
     [ValidateSet(typeof(TextMateLanguages))]
     public string Language { get; set; } = "powershell";
 
+    /// <summary>
+    /// Color theme for token analysis (default: DarkPlus).
+    /// </summary>
     [Parameter()]
     public ThemeName Theme { get; set; } = ThemeName.DarkPlus;
 
+    /// <summary>
+    /// Override file extension for language detection.
+    /// </summary>
     [Parameter(ParameterSetName = "Path")]
     [TextMateExtensionTransform()]
     [ValidateSet(typeof(TextMateExtensions))]
     [Alias("As")]
     public string ExtensionOverride { get; set; } = null!;
 
+    /// <summary>
+    /// Processes each input record from the pipeline.
+    /// </summary>
     protected override void ProcessRecord()
     {
         if (ParameterSetName == "String" && InputObject is not null)
@@ -133,6 +174,9 @@ protected override void ProcessRecord()
         }
     }
 
+    /// <summary>
+    /// Finalizes processing and outputs token debug information.
+    /// </summary>
     protected override void EndProcessing()
     {
         try
@@ -176,6 +220,9 @@ protected override void EndProcessing()
 [Cmdlet(VerbsDiagnostic.Debug, "SixelSupport")]
 public sealed class DebugSixelSupportCmdlet : PSCmdlet
 {
+    /// <summary>
+    /// Processes the cmdlet and outputs Sixel support diagnostic information.
+    /// </summary>
     protected override void ProcessRecord()
     {
         try
@@ -214,12 +261,21 @@ protected override void ProcessRecord()
 [Cmdlet(VerbsDiagnostic.Test, "ImageRendering")]
 public sealed class TestImageRenderingCmdlet : PSCmdlet
 {
+    /// <summary>
+    /// URL or path to image for rendering test.
+    /// </summary>
     [Parameter(Mandatory = true, Position = 0)]
     public string ImageUrl { get; set; } = null!;
 
-    [Parameter()]
+    /// <summary>
+    /// Alternative text for the image.
+    /// </summary>
+    [Parameter(Position = 1)]
     public string AltText { get; set; } = "Test Image";
 
+    /// <summary>
+    /// Processes the cmdlet and tests image rendering.
+    /// </summary>
     protected override void ProcessRecord()
     {
         try

src/Cmdlets/ShowTextMateCmdlet.cs

@@ -13,22 +13,29 @@ namespace PwshSpectreConsole.TextMate.Cmdlets;
 /// </summary>
 [Cmdlet(VerbsCommon.Show, "TextMate", DefaultParameterSetName = "String")]
 [Alias("st","Show-Code")]
-[OutputType(typeof(RenderableBatch))]
+[OutputType(typeof(Spectre.Console.Rows), ParameterSetName = new[] { "String" })]
+[OutputType(typeof(Spectre.Console.Rows), ParameterSetName = new[] { "Path" })]
+[OutputType(typeof(RenderableBatch), ParameterSetName = new[] { "Path" })]
 public sealed class ShowTextMateCmdlet : PSCmdlet
 {
     private static readonly string[] NewLineSplit = ["\r\n", "\n", "\r"];
     private readonly List<string> _inputObjectBuffer = [];
     private string? _sourceExtensionHint;
 
+    /// <summary>
+    /// String content to render with syntax highlighting.
+    /// </summary>
     [Parameter(
         Mandatory = true,
         ValueFromPipeline = true,
         ParameterSetName = "String"
     )]
     [AllowEmptyString]
-    [ValidateNotNull]
-    public string? InputObject { get; set; }
+    public string InputObject { get; set; } = string.Empty;
 
+    /// <summary>
+    /// Path to file to render with syntax highlighting.
+    /// </summary>
     [Parameter(
         Mandatory = true,
         ValueFromPipelineByPropertyName = true,
@@ -37,8 +44,12 @@ public sealed class ShowTextMateCmdlet : PSCmdlet
     )]
     [ValidateNotNullOrEmpty]
     [Alias("FullName")]
-    public string? Path { get; set; }
+    public string Path { get; set; } = string.Empty;
 
+    /// <summary>
+    /// TextMate language ID for syntax highlighting (e.g., 'powershell', 'csharp', 'python').
+    /// If not specified, detected from file extension or content.
+    /// </summary>
     [Parameter(
         ParameterSetName = "String"
     )]
@@ -48,20 +59,35 @@ public sealed class ShowTextMateCmdlet : PSCmdlet
     [ArgumentCompleter(typeof(LanguageCompleter))]
     public string? Language { get; set; }
 
+    /// <summary>
+    /// Color theme to use for syntax highlighting.
+    /// </summary>
     [Parameter()]
     public ThemeName Theme { get; set; } = ThemeName.DarkPlus;
 
+    /// <summary>
+    /// Returns the rendered output object instead of writing directly to host.
+    /// </summary>
     [Parameter]
     public SwitchParameter PassThru { get; set; }
 
+    /// <summary>
+    /// Enables streaming mode for large files, processing in batches.
+    /// </summary>
     [Parameter(
         ParameterSetName = "Path"
     )]
     public SwitchParameter Stream { get; set; }
 
+    /// <summary>
+    /// Number of lines to process per batch when streaming (default: 1000).
+    /// </summary>
     [Parameter(ParameterSetName = "Path")]
     public int BatchSize { get; set; } = 1000;
 
+    /// <summary>
+    /// Processes each input record from the pipeline.
+    /// </summary>
     protected override void ProcessRecord()
     {
         if (ParameterSetName == "String" && InputObject is not null)
@@ -111,6 +137,9 @@ protected override void ProcessRecord()
         }
     }
 
+    /// <summary>
+    /// Finalizes processing after all pipeline records have been processed.
+    /// </summary>
     protected override void EndProcessing()
     {
         // For Path parameter set, each record is processed in ProcessRecord to support streaming multiple files.

src/Cmdlets/SupportCmdlets.cs

@@ -10,15 +10,27 @@ namespace PwshSpectreConsole.TextMate.Cmdlets;
 [Cmdlet(VerbsDiagnostic.Test, "SupportedTextMate")]
 public sealed class TestSupportedTextMateCmdlet : PSCmdlet
 {
+    /// <summary>
+    /// File extension to test for support (e.g., '.ps1').
+    /// </summary>
     [Parameter()]
     public string? Extension { get; set; }
 
+    /// <summary>
+    /// Language ID to test for support (e.g., 'powershell').
+    /// </summary>
     [Parameter()]
     public string? Language { get; set; }
 
+    /// <summary>
+    /// File path to test for support.
+    /// </summary>
     [Parameter()]
     public string? File { get; set; }
 
+    /// <summary>
+    /// Finalizes processing and outputs support check results.
+    /// </summary>
     protected override void EndProcessing()
     {
         if (!string.IsNullOrEmpty(File))
@@ -44,6 +56,9 @@ protected override void EndProcessing()
 [Cmdlet(VerbsCommon.Get, "SupportedTextMate")]
 public sealed class GetSupportedTextMateCmdlet : PSCmdlet
 {
+    /// <summary>
+    /// Finalizes processing and outputs all supported languages.
+    /// </summary>
     protected override void EndProcessing()
     {
         WriteObject(TextMateHelper.AvailableLanguages, enumerateCollection: true);

src/Core/MarkdigSpectreMarkdownRenderer.cs

@@ -1,6 +1,6 @@
 using System.Text;
 using Markdig.Syntax.Inlines;
-using PwshSpectreConsole.TextMate.Core.Helpers;
+using PwshSpectreConsole.TextMate.Helpers;
 using PwshSpectreConsole.TextMate.Extensions;
 using Spectre.Console;
 using TextMateSharp.Themes;

src/Core/Markdown/InlineProcessor.cs

@@ -1,5 +1,5 @@
 using System.Reflection;
-using PwshSpectreConsole.TextMate.Core.Helpers;
+using PwshSpectreConsole.TextMate.Helpers;
 using Spectre.Console;
 using Spectre.Console.Rendering;