Skip to content

Update ConciseView to use TargetObject if applicable #11075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityapatwardhan merged 3 commits into from
Dec 10, 2019
Merged

Update ConciseView to use TargetObject if applicable #11075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7ece16
Update ConciseView to use TargetObject if applicable
SteveL-MSFT Nov 14, 2019
9225ff0
address Jim's feedback
SteveL-MSFT Nov 19, 2019
0dc8f4b
address Jim's feedback
SteveL-MSFT Nov 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 33 additions & 8 deletions ...m.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1050,14 +1050,29 @@ function Get-ConciseViewPositionMessage {
$newline = [Environment]::Newline

if ($myinv -and $myinv.ScriptName -or $myinv.ScriptLineNumber -gt 1 -or $err.CategoryInfo.Category -eq 'ParserError') {
if ($myinv.ScriptName) {
$useTargetObject = $false

# Handle case where there is a TargetObject and we can show the error at the target rather than the script source
if ($_.TargetObject.Line -and $_.TargetObject.LineText) {
$posmsg = ""${resetcolor}$($_.TargetObject.File)${newline}""
$useTargetObject = $true
}
elseif ($myinv.ScriptName) {
$posmsg = ""${resetcolor}$($myinv.ScriptName)${newline}""
}
else {
$posmsg = ""${newline}""
}

$scriptLineNumberLength = $myinv.ScriptLineNumber.ToString().Length
if ($useTargetObject) {
$scriptLineNumber = $_.TargetObject.Line
$scriptLineNumberLength = $_.TargetObject.Line.ToString().Length
}
else {
$scriptLineNumber = $myinv.ScriptLineNumber
$scriptLineNumberLength = $myinv.ScriptLineNumber.ToString().Length
}

if ($scriptLineNumberLength -gt 4) {
$headerWhitespace = ' ' * ($scriptLineNumberLength - 4)
}
Expand All @@ -1069,17 +1084,27 @@ function Get-ConciseViewPositionMessage {

$verticalBar = '|'
$posmsg += ""${accentColor}${headerWhitespace}Line ${verticalBar}${newline}""
$line = $myinv.Line
$highlightLine = $myinv.PositionMessage.Split('+').Count - 1
$offsetLength = $myinv.PositionMessage.split('+')[$highlightLine].Trim().Length

if ($useTargetObject) {
$line = $_.TargetObject.LineText.Trim()
$offsetLength = 0
$offsetInLine = 0
}
else {
$line = $myinv.Line
$highlightLine = $myinv.PositionMessage.Split('+').Count - 1
$offsetLength = $myinv.PositionMessage.split('+')[$highlightLine].Trim().Length
$offsetInLine = $myinv.OffsetInLine - 1
}


# don't color the whole line red
if ($offsetLength -lt $line.Length - 1) {
$line = $line.Insert($myinv.OffsetInLine - 1 + $offsetLength, $resetColor).Insert($myinv.OffsetInLine - 1, $accentColor)
$line = $line.Insert($offsetInLine + $offsetLength, $resetColor).Insert($offsetInLine, $accentColor)
}

$posmsg += ""${accentColor}${lineWhitespace}$($myinv.ScriptLineNumber) ${verticalBar} ${resetcolor}${line}`n""
$offsetWhitespace = ' ' * ($myinv.OffsetInLine - 1)
$posmsg += ""${accentColor}${lineWhitespace}${ScriptLineNumber} ${verticalBar} ${resetcolor}${line}`n""
$offsetWhitespace = ' ' * $offsetInLine
$prefix = ""${accentColor}${headerWhitespace} ${verticalBar} ${errorColor}""
$message = ""${prefix}${offsetWhitespace}^ ""
}
Expand Down
9 changes: 9 additions & 0 deletions test/powershell/engine/Formatting/ErrorView.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,14 @@ Describe 'Tests for $ErrorView' -Tag CI {
$e = pwsh -noprofile -command 'function test-myerror { [cmdletbinding()] param() write-error "myError" }; test-myerror -ErrorAction SilentlyContinue; $error[0] | Out-String'
[string]::Join('', $e).Trim() | Should -BeLike "*test-myerror:*myError*" # wildcard due to VT100
}

It "Pester Should shows test file and not pester" {
$testScript = '1 + 1 | Should -Be 3'
$testScriptPath = Join-Path -Path $TestDrive -ChildPath 'mytest.ps1'
Set-Content -Path $testScriptPath -Value $testScript
$e = { & $testScriptPath } | Should -Throw -ErrorId 'PesterAssertionFailed' -PassThru
$e | Out-String | Should -BeLike "*$testScriptPath*"
$e | Out-String | Should -Not -BeLike '*pester*'
}
}
}