[Preview-2020-5.0] Formatting broken when using default PipelineIndentationStyle setting value of None

[PrzemyslawKlys]

Issue Description

I am experiencing a problem with... formatting. Pressing shortcuts or choosing from menu doesn't work. F8 / F5 works fine. Intellisense works as well.

1589385610-e162f223-5ab6-4d60-bdbb-aa205fe17f2f1589385348230.zip

Attached Logs

Follow the instructions in the README about
capturing and sending logs.

Environment Information

Visual Studio Code

Name	Version
Operating System	Windows_NT x64 10.0.18363
VSCode	1.45.0
PowerShell Extension Version	2020.5.0

PowerShell Information

Name	Value
PSVersion	5.1.18362.752
PSEdition	Desktop
PSCompatibleVersions	1.0 2.0 3.0 4.0 5.0 5.1.18362.752
BuildVersion	10.0.18362.752
CLRVersion	4.0.30319.42000
WSManStackVersion	3.0
PSRemotingProtocolVersion	2.3
SerializationVersion	1.1.0.1

Visual Studio Code Extensions

Visual Studio Code Extensions(Click to Expand)

Extension	Author	Version
beautify	HookyQR	1.5.0
bracket-pair-colorizer-2	CoenraadS	0.1.3
code-settings-sync	Shan	3.4.3
excel-to-markdown-table	csholmq	1.2.2
gistfs	vsls-contrib	0.0.67
gitdoc	vsls-contrib	0.0.6
github-linker	gimenete	0.2.3
gitlens	eamodio	10.2.1
html-preview-vscode	george-alisson	0.2.5
markdown-all-in-one	yzhang	2.8.0
markdown-preview-enhanced	shd101wyy	0.5.3
markdown-shortcuts	mdickin	0.12.0
material-icon-theme	PKief	4.1.0
pdf	tomoki1207	0.6.0
powershell-preview	ms-vscode	2020.5.0
project-manager	alefragnani	10.12.0
rainbow-csv	mechatroner	1.7.0
reg	ionutvmi	1.0.1
vscode-html-css	ecmel	0.2.3
vscode-markdownlint	DavidAnson	0.35.1
vscode-pull-request-github	GitHub	0.16.0
vscode-toggle-quotes	BriteSnow	0.3.2
vscode-versionlens	pflannery	0.27.0
vscode-wakatime	WakaTime	4.0.0
vscode-yaml	redhat	0.8.0
xml	DotJoshJohnson	2.5.0

[TylerLeonhardt]

hmm @bergmeister looks like these are the settings used:

{
    "IncludeRules": [
        "PSPlaceCloseBrace",
        "PSPlaceOpenBrace",
        "PSUseConsistentWhitespace",
        "PSUseConsistentIndentation",
        "PSAlignAssignmentStatement"
    ],
    "Rules": {
        "PSUseConsistentIndentation": {
            "IndentationSize": 4,
            "Enable": true,
            "PipelineIndentation": 3,
            "Kind": "space"
        },
        "PSAvoidUsingCmdletAliases": {},
        "PSPlaceOpenBrace": {
            "Enable": true,
            "NewLineAfter": true,
            "OnSameLine": true,
            "IgnoreOneLineBlock": true
        },
        "PSAlignAssignmentStatement": {
            "Enable": true,
            "CheckHashtable": true
        },
        "PSUseCorrectCasing": {
            "Enable": true
        },
        "PSPlaceCloseBrace": {
            "Enable": true,
            "NewLineAfter": false,
            "IgnoreOneLineBlock": true
        },
        "PSUseConsistentWhitespace": {
            "CheckPipe": true,
            "CheckSeparator": true,
            "CheckOpenBrace": true,
            "Enable": true,
            "CheckParameter": false,
            "CheckOpenParen": true,
            "CheckPipeForRedundantWhitespace": false,
            "CheckInnerBrace": true,
            "CheckOperator": true
        }
    }
}

Does that look alright to you?

[bergmeister]

I updated the preview extension in my insider version of code and cannot repro. @PrzemyslawKlys Have you tried using the > Format Document command? Because I know some other extensions can override the shortcut for formatting a selection

[PrzemyslawKlys]

No change - i tried shorcut, right click format, > format document. I'll uninstall extension and try fresh

[PrzemyslawKlys]

Uninstall/install didn't help

[bergmeister]

I tried switching to PowerShell 5.1 locally to be closer to your environment but it still works... Also tried VS Code stable

[bergmeister]

@TylerLeonhardt the settings look to me.

[TylerLeonhardt]

Another option is to run PSScriptAnalyzer directly to see if anything changes:

$jsonRules = @'
{
    "IncludeRules": [
        "PSPlaceCloseBrace",
        "PSPlaceOpenBrace",
        "PSUseConsistentWhitespace",
        "PSUseConsistentIndentation",
        "PSAlignAssignmentStatement"
    ],
    "Rules": {
        "PSUseConsistentIndentation": {
            "IndentationSize": 4,
            "Enable": true,
            "PipelineIndentation": 3,
            "Kind": "space"
        },
        "PSAvoidUsingCmdletAliases": {},
        "PSPlaceOpenBrace": {
            "Enable": true,
            "NewLineAfter": true,
            "OnSameLine": true,
            "IgnoreOneLineBlock": true
        },
        "PSAlignAssignmentStatement": {
            "Enable": true,
            "CheckHashtable": true
        },
        "PSUseCorrectCasing": {
            "Enable": true
        },
        "PSPlaceCloseBrace": {
            "Enable": true,
            "NewLineAfter": false,
            "IgnoreOneLineBlock": true
        },
        "PSUseConsistentWhitespace": {
            "CheckPipe": true,
            "CheckSeparator": true,
            "CheckOpenBrace": true,
            "Enable": true,
            "CheckParameter": false,
            "CheckOpenParen": true,
            "CheckPipeForRedundantWhitespace": false,
            "CheckInnerBrace": true,
            "CheckOperator": true
        }
    }
}
'@

$scriptContent = Get-Content -Raw ./path/to/file.ps1
Invoke-Formatter -ScriptDefinition $scriptContent -Settings ($jsonRules | ConvertFrom-Json -AsHashtable)

This actually gets me Invoke-Formatter: Cannot parse settings. Will abort the invocation. So either the settings aren't correct or (more likely) I did it wrong.

[PrzemyslawKlys]

Ok, i've it reproduced - only part of formatting doesn't work...

[PrzemyslawKlys]

It doesn't seem to touch things on the left side.. notice the Action on 11th line

[bergmeister]

@TylerLeonhardt Running this exact repro script of you, would also throw a settings parser error in 1.18.3, so does not seem to be a regression

[TylerLeonhardt]

@bergmeister sorry I was side-chaining 😅 that was more of a "Chris pls help fix my script to do what I want" than "PSSA is broken"

[bergmeister]

@TylerLeonhardt No worries, something is wrong in the format of how you convert the JSON because the following (manually converted) works fine:

Invoke-Formatter -ScriptDefinition 'gci' -Settings @{
    "IncludeRules" = @(
        "PSPlaceCloseBrace",
        "PSPlaceOpenBrace",
        "PSUseConsistentWhitespace",
        "PSUseConsistentIndentation",
        "PSAlignAssignmentStatement"
    );
    "Rules"        = @{
        "PSAvoidUsingCmdletAliases"  = @{}
        "PSUseConsistentIndentation" = @{
            "IndentationSize"     = 4;
            "Enable"              = $true;
            "PipelineIndentation" = 3;
            "Kind"                = "space"
        };
        "PSPlaceOpenBrace"           = @{
            "Enable"             = $true;
            "NewLineAfter"       = $true;
            "OnSameLine"         = $true;
            "IgnoreOneLineBlock" = $true
        };
        "PSAlignAssignmentStatement" = @{
            "Enable"         = $true;
            "CheckHashtable" = $true
        };
        "PSUseCorrectCasing"         = @{
            "Enable" = $true
        };
        "PSPlaceCloseBrace"          = @{
            "Enable"             = $true;
            "NewLineAfter"       = $false;
            "IgnoreOneLineBlock" = $true
        };
        "PSUseConsistentWhitespace"  = @{
            "CheckPipe"                       = $true;
            "CheckSeparator"                  = $true;
            "CheckOpenBrace"                  = $true;
            "Enable"                          = $true;
            "CheckParameter"                  = $false;
            "CheckOpenParen"                  = $true;
            "CheckPipeForRedundantWhitespace" = $false;
            "CheckInnerBrace"                 = $true;
            "CheckOperator"                   = $true
        }
    }
}

[bergmeister]

@PrzemyslawKlys Formatting therefore seems to generally work. Please supply the script where the Action hashtable entry does not get corrected. Also: If you revert to the previous extension version and reload, does it still repro? Have you got PSSA 1.19.0 installed locally or do you just use the version that comes out of the box with the extension (both are the same so, no worries)

[PrzemyslawKlys]

@bergmeister

Yes, I jumped the gun a bit because I just was working on a different file that didn't have hash. Generally last preview didn't have an issue and i have installed 1.19.0 before newest preview so not sure if it's related to PSScriptAnalyzer code, more like some configuration on VsCode part.

PS C:\Support\GitHub\GpoZaurr> get-module -ListAvailable PSScriptAnalyzer



    Directory: C:\Users\przemyslaw.klys\Documents\WindowsPowerShell\Modules


ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     1.19.0     PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-ScriptAnalyzer, Invoke-Formatter}


    Directory: C:\Program Files\WindowsPowerShell\Modules


ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     1.18.3     PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-ScriptAnalyzer, Invoke-Formatter}
Script     1.18.2     PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-ScriptAnalyzer, Invoke-Formatter}
Script     1.18.1     PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-ScriptAnalyzer, Invoke-Formatter}


    Directory: C:\Users\przemyslaw.klys\.vscode\extensions\ms-vscode.powershell-preview-2020.5.0\modules


ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     1.19.0     PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-ScriptAnalyzer, Invoke-Formatter}

Here's the code I am testing it with:

@{
Test  = 'dfsf'
    dffdf = 'dddff'
}

foreach ($Test in $Test1) {
foreach ($Test2 in TEst3) {

}
}

Code above replicates it. On PowerShell (not preview) this is translated to

@{
    Test  = 'dfsf'
    dffdf = 'dddff'
}

foreach ($Test in $Test1) {
    foreach ($Test2 in TEst3) {

    }
}

On preview

@{
Test      = 'dfsf'
    dffdf = 'dddff'
}

foreach ($Test in $Test1) {
foreach ($Test2 in TEst3) {

}
}