Function or parameter in cmdlets to escape markup

[ruckii]

According to Spectre.Console Best Practices:

Do escape data when outputting any user input or any external data via Markup using the EscapeMarkup method on the data. Any user input containing [ or ] will likely cause a runtime error while rendering otherwise.

There are at least 2 options:

• Parameter in each cmdlet:

  function Format-SpectrePanel {
  param (
      [Parameter(ValueFromPipeline)]
      [string] $Data,
      [string] $Title,
      [string] $Border = "Rounded",
      [switch] $Expand,
      [switch] $EscapeMarkup,
      [ValidateSpectreColor()]
      [ArgumentCompletionsSpectreColors()]
      [string] $Color = $script:AccentColor.ToString()
  )
  if($EscapeMarkup) {
      $Data = [Spectre.Console.Markup]::Escape($Data)
  }

• Use Spectre.Console method to escape data before PwshSpectreConsole cmdlet call:

  
  #Requires -Version 7.0
  #Requires -Modules PwshSpectreConsole

$data = "][[][]]][[][][][" $escapedData = [Spectre.Console.Markup]::Escape($data) Format-SpectrePanel -Title "Escaped data" -Data $escapedData Format-SpectrePanel -Title "Unescaped data" -Data $data # Exception

[ShaunLawrie]

I added a function for escaping Get-SpectreEscapedText. I wonder if that's enough for most cases? It just pipes the text through that escape function you have there so you can use it in a pipeline.

Cases like your one above:

And receiving untrusted input like the best practice doc talks about:

And mixtures of escaped and unescaped data:

I've pushed this and your other PR to psgallery in https://github.com/ShaunLawrie/PwshSpectreConsole/releases/tag/v0.2.3 Thanks for the feedback.

[ruckii]

Escaping function is what was needed! Thanks a lot!