docs: ✏️ update documentation and examples for Show-PesterResult and Show-PesterResultTree

* Added example usage for `Show-PesterResult` to demonstrate TUI exploration of Pester results.
* Enhanced `Show-PesterResultTree` documentation with a new example and adjusted parameter position.
* Updated `cspell.json` to include "psake" in ignored words list.

Author: HeyItsGilbert

PesterExplorer/Public/Show-PesterResult.ps1

@@ -17,8 +17,7 @@ function Show-PesterResult {
     $pesterResult = Invoke-Pester -Path "path\to\tests.ps1" -PassThru
     Show-PesterResult -PesterResult $pesterResult
 
-    .NOTES
-    This function is part of the PesterExplorer module and requires Spectre.Console to be installed.
+    This example runs Pester tests and opens a TUI to explore the results.
     #>
     [CmdletBinding()]
     [OutputType([void])]

PesterExplorer/Public/Show-PesterResultTree.ps1

@@ -1,4 +1,22 @@
 function Show-PesterResultTree {
+    <#
+    .SYNOPSIS
+    Show a Pester result in a tree format using Spectre.Console.
+
+    .DESCRIPTION
+    This function takes a Pester result object and formats it into a tree structure
+    using Spectre.Console. It is useful for visualizing the structure of Pester results
+    such as runs, containers, blocks, and tests.
+
+    .PARAMETER PesterResult
+    The Pester result object to display. This should be a Pester Run object.
+
+    .EXAMPLE
+    $pesterResult = Invoke-Pester -Path "path\to\tests.ps1" -PassThru
+    Show-PesterResultTree -PesterResult $pesterResult
+
+    This example runs Pester tests and displays the results in a tree format.
+    #>
     [CmdletBinding()]
     [OutputType([void])]
     param (

cspell.json

@@ -7,7 +7,8 @@
     ],
     "words": [],
     "ignoreWords": [
-        "pwsh"
+        "pwsh",
+        "psake"
     ],
     "import": []
 }

docs/en-US/Show-PesterResultTree.md

@@ -39,7 +39,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 0
+Position: 1
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False

tests/Help.tests.ps1

@@ -4,26 +4,23 @@ BeforeDiscovery {
 
     function global:FilterOutCommonParams {
         param ($Params)
-        $commonParams = @(
-            'Debug', 'ErrorAction', 'ErrorVariable', 'InformationAction', 'InformationVariable',
-            'OutBuffer', 'OutVariable', 'PipelineVariable', 'Verbose', 'WarningAction',
-            'WarningVariable', 'Confirm', 'Whatif'
-        )
-        $params | Where-Object { $_.Name -notin $commonParams } | Sort-Object -Property Name -Unique
+        $commonParameters = [System.Management.Automation.PSCmdlet]::CommonParameters +
+        [System.Management.Automation.PSCmdlet]::OptionalCommonParameters
+        $params | Where-Object { $_.Name -notin $commonParameters } | Sort-Object -Property Name -Unique
     }
 
-    $manifest             = Import-PowerShellDataFile -Path $env:BHPSModuleManifest
-    $outputDir            = Join-Path -Path $env:BHProjectPath -ChildPath 'Output'
-    $outputModDir         = Join-Path -Path $outputDir -ChildPath $env:BHProjectName
-    $outputModVerDir      = Join-Path -Path $outputModDir -ChildPath $manifest.ModuleVersion
+    $manifest = Import-PowerShellDataFile -Path $env:BHPSModuleManifest
+    $outputDir = Join-Path -Path $env:BHProjectPath -ChildPath 'Output'
+    $outputModDir = Join-Path -Path $outputDir -ChildPath $env:BHProjectName
+    $outputModVerDir = Join-Path -Path $outputModDir -ChildPath $manifest.ModuleVersion
     $outputModVerManifest = Join-Path -Path $outputModVerDir -ChildPath "$($env:BHProjectName).psd1"
 
     # Get module commands
     # Remove all versions of the module from the session. Pester can't handle multiple versions.
     Get-Module $env:BHProjectName | Remove-Module -Force -ErrorAction Ignore
     Import-Module -Name $outputModVerManifest -Verbose:$false -ErrorAction Stop
     $params = @{
-        Module      = (Get-Module $env:BHProjectName)
+        Module = (Get-Module $env:BHProjectName)
         CommandType = [System.Management.Automation.CommandTypes[]]'Cmdlet, Function' # Not alias
     }
     if ($PSVersionTable.PSVersion.Major -lt 6) {
@@ -39,22 +36,22 @@ Describe "Test help for <_.Name>" -ForEach $commands {
 
     BeforeDiscovery {
         # Get command help, parameters, and links
-        $command               = $_
-        $commandHelp           = Get-Help $command.Name -ErrorAction SilentlyContinue
-        $commandParameters     = global:FilterOutCommonParams -Params $command.ParameterSets.Parameters
+        $command = $_
+        $commandHelp = Get-Help $command.Name -ErrorAction SilentlyContinue
+        $commandParameters = global:FilterOutCommonParams -Params $command.ParameterSets.Parameters
         $commandParameterNames = $commandParameters.Name
-        $helpLinks             = $commandHelp.relatedLinks.navigationLink.uri
+        $helpLinks = $commandHelp.relatedLinks.navigationLink.uri
     }
 
     BeforeAll {
         # These vars are needed in both discovery and test phases so we need to duplicate them here
-        $command                = $_
-        $commandName            = $_.Name
-        $commandHelp            = Get-Help $command.Name -ErrorAction SilentlyContinue
-        $commandParameters      = global:FilterOutCommonParams -Params $command.ParameterSets.Parameters
-        $commandParameterNames  = $commandParameters.Name
-        $helpParameters         = global:FilterOutCommonParams -Params $commandHelp.Parameters.Parameter
-        $helpParameterNames     = $helpParameters.Name
+        $command = $_
+        $commandName = $_.Name
+        $commandHelp = Get-Help $command.Name -ErrorAction SilentlyContinue
+        $commandParameters = global:FilterOutCommonParams -Params $command.ParameterSets.Parameters
+        $commandParameterNames = $commandParameters.Name
+        $helpParameters = global:FilterOutCommonParams -Params $commandHelp.Parameters.Parameter
+        $helpParameterNames = $helpParameters.Name
     }
 
     # If help is not found, synopsis in auto-generated help is the syntax diagram
@@ -81,12 +78,12 @@ Describe "Test help for <_.Name>" -ForEach $commands {
         (Invoke-WebRequest -Uri $_ -UseBasicParsing).StatusCode | Should -Be '200'
     }
 
-    Context "Parameter <_.Name>" -Foreach $commandParameters {
+    Context "Parameter <_.Name>" -ForEach $commandParameters {
 
         BeforeAll {
-            $parameter         = $_
-            $parameterName     = $parameter.Name
-            $parameterHelp     = $commandHelp.parameters.parameter | Where-Object Name -eq $parameterName
+            $parameter = $_
+            $parameterName = $parameter.Name
+            $parameterHelp = $commandHelp.parameters.parameter | Where-Object Name -EQ $parameterName
             $parameterHelpType = if ($parameterHelp.ParameterValue) { $parameterHelp.ParameterValue.Trim() }
         }
 
@@ -107,7 +104,7 @@ Describe "Test help for <_.Name>" -ForEach $commands {
         }
     }
 
-    Context "Test <_> help parameter help for <commandName>" -Foreach $helpParameterNames {
+    Context "Test <_> help parameter help for <commandName>" -ForEach $helpParameterNames {
 
         # Shouldn't find extra parameters in help.
         It "finds help parameter in code: <_>" {