Write-Error should use positional binding to -ErrorRecord and -Exception
See original GitHub issueWhen using the parameter sets selected by -ErrorRecord
/ -Exception
of Write-Error
, it makes sense to bind (the first) positional argument of types (derived from) System.Management.Automation.ErrorRecord
/ System.Exception
to those parameters.
Currently, that doesn’t happen, because these parameters lack the Position=0
attribute field in their `Parameter attributes.
The result is that using something like Write-Error $_
in an apparent effort to pass the System.Management.Automation.ErrorRecord
instance in $_
through, you end up with the equivalent of:
Write-Error -Message $_
rather than the more sensible - and probably expected:
Write-Error -ErrorRecord $_
While the two resulting error records ultimately contain the same message (description), the specifics of the input error record are lost.
The same applies analogously to -Exception
.
The fix is trivial: Add Position = 0
to the following two locations:
Steps to reproduce
Run the following tests:
# ErrorRecord
try { [int]::parse('foo') } catch {}; (Write-Error $Error[0] 2>&1).Exception.GetType().FullName | Should -Be System.Management.Automation.MethodInvocationException
# Exception
try { [int]::parse('foo') } catch {}; (Write-Error $Error[0].Exception.InnerException 2>&1).Exception.GetType().FullName | Should -Be System.FormatException
# Make sure that a string still binds to -Message.
try { [int]::parse('foo') } catch {}; (Write-Error "$($Error[0])" 2>&1).Exception.GetType().FullName | Should -Be Microsoft.PowerShell.Commands.WriteErrorException
Expected behavior
All tests should pass.
Actual behavior
The first two tests fail, because the positional arguments bind to -Message
, resulting in a generic Microsoft.PowerShell.Commands.WriteErrorException
exception wrapper.
Environment data
PowerShell Core 7.0.0-preview.4
Issue Analytics
- State:
- Created 4 years ago
- Comments:9 (3 by maintainers)
I’ll work on this one.
Excellent! This seems like a minor enhancement-type change. Marking it for Hacktoberfest. 😁