Add support to Get-Error to handle BoundParameters (PowerShell#20640)

SteveL-MSFT · web-flow · commit 9ceae0c544f1 · 2024-08-26T19:25:16.000-04:00
* Add support to `Get-Error` to handle BoundParameters

* sort the keys

* change to generalize for all dictionaries

* address Patrick's comment to generalize and use one codepath for dictionaries

* address codefactor
diff --git a/src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs b/src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
@@ -918,9 +918,9 @@ private static IEnumerable<FormatViewDefinition> ViewsOf_System_Management_Autom
                                             $null = $output.Append($prop.Value)
                                         }
                                         # Dictionary and Hashtable we want to show as Key/Value pairs, we don't do the extra whitespace alignment here
-                                        elseif ($prop.Value.GetType().Name.StartsWith('Dictionary') -or $prop.Value.GetType().Name -eq 'Hashtable') {
+                                        elseif ($prop.Value -is [System.Collections.IDictionary]) {
                                             $isFirstElement = $true
-                                            foreach ($key in $prop.Value.Keys) {
+                                            foreach ($key in ($prop.Value.Keys | Sort-Object)) {
                                                 if ($isFirstElement) {
                                                     $null = $output.Append($newline)
                                                 }
diff --git a/test/powershell/Modules/Microsoft.PowerShell.Utility/Get-Error.Tests.ps1 b/test/powershell/Modules/Microsoft.PowerShell.Utility/Get-Error.Tests.ps1
@@ -155,4 +155,18 @@ Describe 'Get-Error tests' -Tag CI {
         $out = pwsh -noprofile -command 'Set-StrictMode -Version Latest; $PSStyle.OutputRendering = "PlainText"; 1/0; Get-Error' | Out-String
         $out | Should -Match "Message : Attempted to divide by zero."
     }
+
+    It 'BoundParameters show as name/value pairs' {
+        try {
+            function test { [CmdletBinding()]param($A,$B) }
+            $Param = @{ A = "First"; B = "Second"; C = 24 }
+            test @Param
+        }
+        catch {
+            # do nothing
+        }
+
+        $out = Get-Error | Out-String
+        $out | Should -Match "BoundParameters\s+:\s+A : First\s+B : Second\s"
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -918,9 +918,9 @@ private static IEnumerable<FormatViewDefinition> ViewsOf_System_Management_Autom`
`918`	`918`	`$null = $output.Append($prop.Value)`
`919`	`919`	`}`
`920`	`920`	`# Dictionary and Hashtable we want to show as Key/Value pairs, we don't do the extra whitespace alignment here`
`921`		`- elseif ($prop.Value.GetType().Name.StartsWith('Dictionary') -or $prop.Value.GetType().Name -eq 'Hashtable') {`
	`921`	`+ elseif ($prop.Value -is [System.Collections.IDictionary]) {`
`922`	`922`	`$isFirstElement = $true`
`923`		`- foreach ($key in $prop.Value.Keys) {`
	`923`	`+ foreach ($key in ($prop.Value.Keys \| Sort-Object)) {`
`924`	`924`	`if ($isFirstElement) {`
`925`	`925`	`$null = $output.Append($newline)`
`926`	`926`	`}`