en-US/PesterExplorer-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-PesterResult</command:name> <command:verb>Show</command:verb> <command:noun>PesterResult</command:noun> <maml:description> <maml:para>Open a TUI to explore the Pester result object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Show a Pester result in a TUI (Text User Interface) using Spectre.Console. This function builds a layout with a header, a list of items, and a preview panel.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-PesterResult</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>PesterResult</maml:name> <maml:description> <maml:para>The Pester result object to display. This should be a Pester Run object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Run</command:parameterValue> <dev:type> <maml:name>Run</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoShortcutPanel</maml:name> <maml:description> <maml:para>If specified, the shortcut panel will not be displayed at the bottom of the TUI.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>PesterResult</maml:name> <maml:description> <maml:para>The Pester result object to display. This should be a Pester Run object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Run</command:parameterValue> <dev:type> <maml:name>Run</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoShortcutPanel</maml:name> <maml:description> <maml:para>If specified, the shortcut panel will not be displayed at the bottom of the TUI.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$pesterResult = Invoke-Pester -Path "path\to\tests.ps1" -PassThru Show-PesterResult -PesterResult $pesterResult</dev:code> <dev:remarks> <maml:para>This example runs Pester tests and opens a TUI to explore the results.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-PesterResultTree</command:name> <command:verb>Show</command:verb> <command:noun>PesterResultTree</command:noun> <maml:description> <maml:para>Show a Pester result in a tree format using Spectre.Console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-PesterResultTree</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>PesterResult</maml:name> <maml:description> <maml:para>The Pester result object to display. This should be a Pester Run object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Run</command:parameterValue> <dev:type> <maml:name>Run</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>PesterResult</maml:name> <maml:description> <maml:para>The Pester result object to display. This should be a Pester Run object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Run</command:parameterValue> <dev:type> <maml:name>Run</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$pesterResult = Invoke-Pester -Path "path\to\tests.ps1" -PassThru Show-PesterResultTree -PesterResult $pesterResult</dev:code> <dev:remarks> <maml:para>This example runs Pester tests and displays the results in a tree format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |