PSScriptAnalyzer icon indicating copy to clipboard operation
PSScriptAnalyzer copied to clipboard

Lines unaffected from sytax errors get formatted wrong on PowerShell 5

Open xmrv opened this issue 2 years ago • 2 comments

Before submitting a bug report:

  • Make sure you are able to repro it on the latest released version
  • Perform a quick search for existing issues to check if this bug has already been reported

Steps to reproduce

  1. Open a PowerShell 5 window
  2. Type the following code with intentional syntax errors:
$code = @"
@(
  @{
    ""
  }
  ""
)
test /parameter
"@

Invoke-Formatter $code

Expected behavior

Slash should not be seperated from parameter since it isn't affected from the syntax error.

@(
    @{
        ""
    }
    ""
)
test /parameter

Actual behavior

Slash is treated as an operator and is seperated from parameter. This behavior is unique to PowerShell 5 and does not occur in v7.

@(
    @{
        ""
    }
    ""
)
test / parameter

If an unexpected error was thrown then please report the full error details using e.g. $error[0] | Select-Object *

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.19041.1320
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.19041.1320
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }

1.20.0

xmrv avatar Jun 24 '22 15:06 xmrv

Hi @xmrv thanks for opening this issue! We are aware of some of these bugs with and will mark up for grabs. Fortunately this does not seem to repro in PowerShell 7.

StevenBucher98 avatar Jul 20 '22 21:07 StevenBucher98

Thanks for the detailed and minimal repro. I can confirm this happens only in Windows PowerShell. When narrowing it down further it's the CheckOperator option of PSUseConsistentWhitespace. You could turn this option off as a workaround or set powershell.codeFormatting.whitespaceAroundOperator to false as a VS-Code setting or like you said use PowerShell 7. I am interested to look at this at some point but due to low impact and scenario (invalid syntax) it's not a priority to investigate further. What I suspect is happening is that the PowerShell parser (on which PSSA relies on) got improved for edge cases like that to be more robust to invalid syntax) and that's probably what we see here.

bergmeister avatar Aug 30 '22 21:08 bergmeister