[0.3.1] Release (#8)

* Added VIM (i.e. `hjkl`) navigation support.
* Implemented parameter validation and made parameters mandatory to
prevent unexpected command failures.
* Updated documentation to reflect changes in parameter requirements for
`Show-PesterResult` and `Show-PesterResultTree`.

- Fixes #3

Author: HeyItsGilbert

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.1] 2025-05-30
+
+### Added
+
+- Add VIM (i.e. `hjkl`) navigation support.
+
+### Fixed
+
+- Add parameter validation and mandatory to ensure commands don't fail
+  unexpectedly.
+
 ## [0.3.0] 2025-05-29
 
 ### Added

PesterExplorer/PesterExplorer.psd1

@@ -12,7 +12,7 @@
     RootModule = 'PesterExplorer.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.3.0'
+    ModuleVersion = '0.3.1'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

PesterExplorer/Private/Get-ShortcutKeyPanel.ps1

@@ -20,11 +20,11 @@ function Get-ShortcutKeyPanel {
     #>
     [CmdletBinding()]
     $shortcutKeys = @(
-        "Up, Down - Navigate",
+        "Up/J, Down/K - Navigate",
         "Home, End - Jump to Top/Bottom",
         "PageUp, PageDown - Scroll",
-        "Enter - Explore",
-        "Tab - Switch Panel",
+        "Enter - Explore Item",
+        "Tab, Left/H, Right/L - Switch Panel",
         "Esc - Back",
         "Ctrl+C - Exit"
     )

PesterExplorer/Public/Show-PesterResult.ps1

@@ -27,6 +27,7 @@ function Show-PesterResult {
         Justification='This is actually used in the script block.'
     )]
     param (
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [Pester.Run]
         $PesterResult,
@@ -89,14 +90,13 @@ function Show-PesterResult {
 
             # Handle input
             $lastKeyPressed = Get-LastKeyPressed
-            # ToDo: Add vim navigation keys
             if ($null -ne $lastKeyPressed) {
                 #region List Navigation
                 if($selectedPane -eq 'list') {
-                    if ($lastKeyPressed.Key -eq "DownArrow") {
+                    if ($lastKeyPressed.Key -in @("j", "DownArrow")) {
                         $selectedItem = $list[($list.IndexOf($selectedItem) + 1) % $list.Count]
                         $scrollPosition = 0
-                    } elseif ($lastKeyPressed.Key -eq "UpArrow") {
+                    } elseif ($lastKeyPressed.Key -in @("k", "UpArrow")) {
                         $selectedItem = $list[($list.IndexOf($selectedItem) - 1 + $list.Count) % $list.Count]
                         $scrollPosition = 0
                     } elseif ($lastKeyPressed.Key -eq "PageDown") {
@@ -115,7 +115,7 @@ function Show-PesterResult {
                     } elseif ($lastKeyPressed.Key -eq "End") {
                         $selectedItem = $list[-1]
                         $scrollPosition = 0
-                    } elseif ($lastKeyPressed.Key -in @("Tab", "RightArrow")) {
+                    } elseif ($lastKeyPressed.Key -in @("Tab", "RightArrow", "l")) {
                         $selectedPane = 'preview'
                     } elseif ($lastKeyPressed.Key -eq "Enter") {
                         <# Recurse into Pester Object #>
@@ -150,8 +150,7 @@ function Show-PesterResult {
                 }
                 else {
                     #region Preview Navigation
-                    # ToDo: Add support for scrolling the right panel
-                    if ($lastKeyPressed.Key -in "Escape", "Tab", "LeftArrow", "RightArrow") {
+                    if ($lastKeyPressed.Key -in "Escape", "Tab", "LeftArrow", "h") {
                         $selectedPane = 'list'
                     } elseif ($lastKeyPressed.Key -eq "Down") {
                         # Scroll down in the preview panel
@@ -172,8 +171,22 @@ function Show-PesterResult {
 
             # Generate new data
             $titlePanel = Get-TitlePanel -Item $object
-            $listPanel = Get-ListPanel -List $list -SelectedItem $selectedItem -SelectedPane $selectedPane
-            $previewPanel = Get-PreviewPanel -Items $items -SelectedItem $selectedItem -ScrollPosition $scrollPosition -PreviewHeight $previewHeight -PreviewWidth $previewWidth -SelectedPane $selectedPane
+            $getListPanelSplat = @{
+                List = $list
+                SelectedItem = $selectedItem
+                SelectedPane = $selectedPane
+            }
+            $listPanel = Get-ListPanel @getListPanelSplat
+
+            $getPreviewPanelSplat = @{
+                Items = $items
+                SelectedItem = $selectedItem
+                ScrollPosition = $scrollPosition
+                PreviewHeight = $previewHeight
+                PreviewWidth = $previewWidth
+                SelectedPane = $selectedPane
+            }
+            $previewPanel = Get-PreviewPanel @getPreviewPanelSplat
 
             # Update layout
             $layout["header"].Update($titlePanel) | Out-Null

PesterExplorer/Public/Show-PesterResultTree.ps1

@@ -20,6 +20,8 @@ function Show-PesterResultTree {
     [CmdletBinding()]
     [OutputType([void])]
     param (
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
         [Pester.Run]
         $PesterResult
     )

docs/en-US/Show-PesterResult.md

@@ -13,7 +13,7 @@ Open a TUI to explore the Pester result object.
 ## SYNTAX
 
 ```
-Show-PesterResult [[-PesterResult] <Run>] [-NoShortcutPanel] [-ProgressAction <ActionPreference>]
+Show-PesterResult [-PesterResult] <Run> [-NoShortcutPanel] [-ProgressAction <ActionPreference>]
  [<CommonParameters>]
 ```
 
@@ -42,7 +42,7 @@ Type: Run
 Parameter Sets: (All)
 Aliases:
 
-Required: False
+Required: True
 Position: 1
 Default value: None
 Accept pipeline input: False

docs/en-US/Show-PesterResultTree.md

@@ -13,7 +13,7 @@ Show a Pester result in a tree format using Spectre.Console.
 ## SYNTAX
 
 ```
-Show-PesterResultTree [[-PesterResult] <Run>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Show-PesterResultTree [-PesterResult] <Run> [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -43,7 +43,7 @@ Type: Run
 Parameter Sets: (All)
 Aliases:
 
-Required: False
+Required: True
 Position: 1
 Default value: None
 Accept pipeline input: False