PowerShell / PSScriptAnalyzer

Download ScriptAnalyzer from PowerShellGallery
https://www.powershellgallery.com/packages/PSScriptAnalyzer/
MIT License
1.87k stars 378 forks source link

Formatting the PowerShell script removes necessary pipe operator `|` #1685

Open zhaohaoshu opened 3 years ago

zhaohaoshu commented 3 years ago

System Details

System Details Output

### VSCode version: 1.51.1 e5a624b788d92b8d34d1392e4c4d9789406efe8f x64

### VSCode extensions:
janisdd.vscode-edit-csv@0.6.0
ms-python.python@2021.2.633441544
ms-toolsai.jupyter@2021.2.576440691
ms-vscode.cpptools@1.1.3
ms-vscode.hexeditor@1.3.0
ms-vscode.powershell@2020.6.0
redhat.vscode-commons@0.0.6
redhat.vscode-xml@0.16.1

### PSES version: 2.2.0.0

### PowerShell version:

Name                           Value
----                           -----
PSVersion                      7.1.3
PSEdition                      Core
GitCommitId                    7.1.3
OS                             Microsoft Windows 10.0.19043
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Issue Description

Create a PowerShell file, input following script, and hit Alt+Shift+F. The pipe operator in $a | ForEach-Object { $_ } is removed.

$a=@('a','b','c')
$b=@{
    a=1
    b=2
    c=3
}
$b | Select-Object -Property ($a | ForEach-Object { $_ })

Related settings in settings.json:

    "powershell.codeFormatting.trimWhitespaceAroundPipe": true,
    "powershell.codeFormatting.useCorrectCasing": true,
    "powershell.codeFormatting.whitespaceBetweenParameters": true,

Expected Behaviour

The format result should look like:

$a = @('a', 'b', 'c')
$b = @{
    a = 1
    b = 2
    c = 3
}
$b | Select-Object -Property ($a | ForEach-Object { $_ })

Actual Behaviour

The format result is (note that the | is missing):

$a = @('a', 'b', 'c')
$b = @{
    a = 1
    b = 2
    c = 3
}
$b | Select-Object -Property ($a ForEach-Object { $_ })
zhaohaoshu commented 3 years ago

Adding another case that necessary character is removed.

Before format:

param(
    [string]$s = (Join-Path a ([datetime]::Now.ToString('yyyyMMddHHmmss')))
)

After format (note that :: is changed to :):

param(
    [string]$s = (Join-Path a ([datetime]:Now.ToString('yyyyMMddHHmmss')))
)
zhaohaoshu commented 3 years ago

And another case that removes the + operator.

Before: Join-Path a ('a' + '.txt') After: Join-Path a ('a' '.txt')