Pipeline formatting is broken with Select-Object and custom property with nested pipeline

[JeanPhilippeGeorge]

Prerequisites

• I have written a descriptive issue title.
• I have searched all open and closed issues to ensure it has not already been reported.
• I have read the troubleshooting guide.
• I am sure this issue is with the extension itself and does not reproduce in a standalone PowerShell instance.
• I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.
• If this is a security issue, I have read the security issue reporting guidance.

Summary

When formatting (Shift + Alt + f) code with pipelines and custom properties will go some tabs on the right or remove cmdlet.

Before:

function X {
	# Ok 
	Get-TransportRule | 
		Select-Object -Property @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }, @{N = 'RecipientDomainIs'; E = { ($_.RecipientDomainIs | Sort-Object) -join ', ' } }, BlindCopyTo | 
		ConvertTo-Html -Fragment

	# After these lines will go one tab to the right
	Get-TransportRule | 
		Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } } | ConvertTo-Html -Fragment
		
	# After these lines will  go one more tab to the right
	Get-TransportRule | 
		Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }
}

function Xx {

}

After with settings: "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline"
Seems that if there is one more pipeline on next line it's ok.

function X {
	# Ok 
	Get-TransportRule | 
		Select-Object -Property @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }, @{N = 'RecipientDomainIs'; E = { ($_.RecipientDomainIs | Sort-Object) -join ', ' } }, BlindCopyTo | 
		ConvertTo-Html -Fragment

	# After these lines will go one tab to the right
	Get-TransportRule | 
		Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } } | ConvertTo-Html -Fragment
		
		# After these lines will go one more tab to the right
		Get-TransportRule | 
			Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }
		}

		function Xx {

		}

Or worst with settings: "powershell.codeFormatting.pipelineIndentationStyle": "None"
Select-Object and ConvertTo-Html have now disapeared!

function X {
	# Missing Select-Object and ConvertTo-Html
	Get-TransportRule | 
	-Property @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }, @{N = 'RecipientDomainIs'; E = { ($_.RecipientDomainIs | Sort-Object) -join ', ' } }, BlindCopyTo | 
	-Fragment

	# Missing Select-Object 
	Get-TransportRule | 
	name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } } | ConvertTo-Html -Fragment
		
	# Missing Select-Object 
	Get-TransportRule | 
	name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }
}

function Xx {

}

PowerShell Version

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

Visual Studio Code Version

1.69.2
3b889b090b5ad5793f524b5d1d39fda662b96a2a
x64

Extension Version

ms-vscode.powershell@2022.7.2

Steps to Reproduce

Copy and paste sample and do shift + alt + f with various settings of "powershell.codeFormatting.pipelineIndentationStyle"

function X {
	# Ok 
	Get-TransportRule | 
		Select-Object -Property @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }, @{N = 'RecipientDomainIs'; E = { ($_.RecipientDomainIs | Sort-Object) -join ', ' } }, BlindCopyTo | 
		ConvertTo-Html -Fragment

	# After these lines will go one tab to the right
	Get-TransportRule | 
		Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } } | ConvertTo-Html -Fragment
		
	# After these lines will  go one more tab to the right
	Get-TransportRule | 
		Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }
}

function Xx {

}

Visuals

No response

Logs

No response

[JeanPhilippeGeorge]

My .vscode\settings.json:

{
	"files.insertFinalNewline": true,
	"files.trimTrailingWhitespace": true,
	"editor.insertSpaces": false,
	"editor.tabSize": 4,
	"editor.detectIndentation": false,
	"powershell.codeFormatting.preset": "OTBS",
	"powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
	"[powershell]": {
		"files.encoding": "utf8bom",
		"files.autoGuessEncoding": true,
	},
	"powershell.codeFormatting.trimWhitespaceAroundPipe": true,
	"powershell.codeFormatting.useCorrectCasing": true,
	"powershell.codeFormatting.whitespaceBetweenParameters": true,
	"powershell.codeFormatting.autoCorrectAliases": true
  }

[JeanPhilippeGeorge]

And this:

	$Data |
		Sort-Object Status, PercentageComplete | 
		Select-Object identity, status, PercentageComplete, SyncedItemCount, SkippedItemCount, 
			@{N = 'SizeGB'; E = { "{0,6:N1}" -f [math]::Round((Convert-O365ByteQuantifiedSizeToInt64 $_.EstimatedTotalTransferSize) / 1GB, 1) } },
			@{ N = 'TransferredGB'; E = { "{0,13:N1}" -f [math]::Round((Convert-O365ByteQuantifiedSizeToInt64 $_.BytesTransferred) / 1GB, 1) } } |
		Format-Table -AutoSize | 
		Out-String -Stream |
		ForEach-Object {
			if ($_ -match 'synced' -and $_ -notmatch 'Identity') {
				Write-Host $_ -ForegroundColor Green
			} elseif ($_ -match 'failed') {
				Write-Host $_ -ForegroundColor Red
			} else {
				Write-Host $_
			} 
		}

with settings: "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline" is reformatted to:

	$Data |
		Sort-Object Status, PercentageComplete | 
		Select-Object identity, status, PercentageComplete, SyncedItemCount, SkippedItemCount, 
		@{N = 'SizeGB'; E = { "{0,6:N1}" -f [math]::Round((Convert-O365ByteQuantifiedSizeToInt64 $_.EstimatedTotalTransferSize) / 1GB, 1) } },
		@{ N = 'TransferredGB'; E = { "{0,13:N1}" -f [math]::Round((Convert-O365ByteQuantifiedSizeToInt64 $_.BytesTransferred) / 1GB, 1) } } |
		Format-Table -AutoSize | 
		Out-String -Stream |
		ForEach-Object {
			if ($_ -match 'synced' -and $_ -notmatch 'Identity') {
				Write-Host $_ -ForegroundColor Green
			} elseif ($_ -match 'failed') {
				Write-Host $_ -ForegroundColor Red
			} else {
				Write-Host $_
			} 
		}

[JeanPhilippeGeorge]

Still with settings: "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline" is reformatted to:
I added comment where I think it's wrong

function Get-SuiviVmInfo {
	[cmdletBinding()]
	param (
		[Parameter(Mandatory)]
		[Alias("HostName")]
		[string]$ComputerName
	)

	$ScriptBlock = {
		Get-VM | ForEach-Object {
			$Vhds = $_ |
				Get-VMHardDiskDrive |
				Get-VHD |
				Select-Object @{N = 'FileName'; E = { Split-Path -Path $_.Path -Leaf } },
				@{N = 'VhdFormat'; E = { $_.VhdFormat.ToString() } },
				@{N = 'VhdType'; E = { $_.VhdType.ToString() } },
				@{N = 'VhdFragmentationPercentage'; E = { $_.FragmentationPercentage / 100 } },
				@{N = 'VhdCapacity'; E = { $_.Size } },
				@{N = 'VhdFileSize'; E = { $_.FileSize } }
                                # Lines above should be one tab on the right

                                # Lines below should be one tab on the left
				$_ | ForEach-Object {
					try {
						$State = $_.State.ToString()
						$Heartbeat = $_.Heartbeat.ToString()
						$IntegrationServicesVersion = $_.IntegrationServicesVersion.ToString()
					} catch {
						$State = 'Stopped'
						$Heartbeat = ''
						$IntegrationServicesVersion = ''
					}
					[PSCustomObject]@{
						Name                       = $_.Name
						State                      = $State
						Status                     = $_.Status
						Heartbeat                  = $Heartbeat
						Generation                 = $_.Generation
						ProcessorCount             = $_.ProcessorCount
						CPUUsage                   = $_.CPUUsage
						MemoryAssigned             = $_.MemoryAssigned
						MemoryDemand               = $_.MemoryDemand
						MemoryStatus               = $_.MemoryStatus
						MemoryStartup              = $_.MemoryStartup
						DynamicMemoryEnabled       = $_.DynamicMemoryEnabled
						MemoryMinimum              = $_.MemoryMinimum
						MemoryMaximum              = $_.MemoryMaximum
						IntegrationServicesState   = $_.IntegrationServicesState
						IntegrationServicesVersion = $IntegrationServicesVersion
						VHDs                       = [Object[]]$Vhds
					}
				}
			}
		}

		if ($ComputerName.Count -eq 1 -and $ComputerName -eq "$Env:ComputerName") {
			Write-Verbose "Local command"
			$VMs = & $ScriptBlock | Select-Object * -ExcludeProperty PSComputerName, RunspaceId, PSShowComputername
		} else {
			$Parameters = @{
				ComputerName = @($ComputerName)
				ScriptBlock  = $ScriptBlock
			}
			if ($Credential) {
				$Parameters.Credential = $Credential
			}
			if ($UseSSL) {
				$Parameters.UseSSL = $true
			}
			Write-Verbose "Invoke-Command"
			$VMs = Invoke-Command @Parameters | Select-Object * -ExcludeProperty PSComputerName, RunspaceId, PSShowComputername
		}

		$VMs | ForEach-Object {
			try {
				$Disks = @()
				$Disks = Get-CimInstance -ClassName Win32_Volume -Filter "DriveType = 3" -ComputerName $_.Name -ErrorAction SilentlyContinue |
					Where-Object { $_.Capacity -ge 1GB } |
					Select-Object @{ N = 'Name'; E = { if ($_.DriveLetter) { $_.DriveLetter } else { $_.Label } } }, FileSystem, Capacity, @{ N = 'Used'; E = { $_.Capacity - $_.FreeSpace } }, FreeSpace
                                        # Lines below should be one tab on the left
					$Disks = @($Disks)
				} catch {
				}

				for ($i = 0; $i -lt $_.Vhds.Count; $i++) {
					if ($Disks.Count -ge $_.Vhds.Count) {
						$_.Vhds[$i] | Add-Member -NotePropertyName OsCapacity -NotePropertyValue $Disks[$i].Capacity
						$_.Vhds[$i] | Add-Member -NotePropertyName OsUsed -NotePropertyValue $Disks[$i].Used
					}
				}
				$_
			}
		}

[andyleejordan]

Can you reproduce this with just PSScriptAnalyzer itself, or with older versions of the extension?

[JeanPhilippeGeorge]

@andschwa not sure to understand your question with just PSScriptAnalyzer.

If I disable the Powershell extension and restart when I type shift + alt + f vscode says that there is no formatter and asks if I want to install one. So I'm thinking that is not what you are asking?

With vscode-powershell 2022.6.3 same bugs
With vscode-powershell 2022.6.1 same bugs
With vscode-powershell 2021.8.0 same bugs

[andyleejordan]

Underneath the covers, the extension is just using the PSScriptAnalyzer module to format the code. Can you try formatting the code directly through the module on the command-line, no extension in sight, to see if this is a PSSA bug or bug with our integration of PSSA?

You would call Invoke-Formatter. And here is our base set of PSSA rules that are supplied to that command.

This issue was closed automatically as repro info was indicated as needed, but there has been no activity in over a week. Please feel free to reopen with any available information!

[JeanPhilippeGeorge]

@andschwa hello, I'm back from vacation. Sorry that it takes me so much time to answer.

I installed PSScryptAnalyzer and took the settings from CodeFormattingOTBS.psd1 from your default settings link which should be a good approximation.

I made the following script to test :

$CodeFormattingOTBSSettings = @{
    IncludeRules = @(
        'PSPlaceOpenBrace',
        'PSPlaceCloseBrace',
        'PSUseConsistentWhitespace',
        'PSUseConsistentIndentation',
        'PSAlignAssignmentStatement',
        'PSUseCorrectCasing'
    )

    Rules        = @{
        PSPlaceOpenBrace           = @{
            Enable             = $true
            OnSameLine         = $true
            NewLineAfter       = $true
            IgnoreOneLineBlock = $true
        }

        PSPlaceCloseBrace          = @{
            Enable             = $true
            NewLineAfter       = $false
            IgnoreOneLineBlock = $true
            NoEmptyLineBefore  = $false
        }

        PSUseConsistentIndentation = @{
            Enable          = $true
            Kind            = 'space'
            PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
            IndentationSize = 4
        }

        PSUseConsistentWhitespace  = @{
            Enable                          = $true
            CheckInnerBrace                 = $true
            CheckOpenBrace                  = $true
            CheckOpenParen                  = $true
            CheckOperator                   = $true
            CheckPipe                       = $true
            CheckPipeForRedundantWhitespace = $false
            CheckSeparator                  = $true
            CheckParameter                  = $false
            IgnoreAssignmentOperatorInsideHashTable = $true
        }

        PSAlignAssignmentStatement = @{
            Enable         = $true
            CheckHashtable = $true
        }

        PSUseCorrectCasing     = @{
            Enable             = $true
        }
    }
}

$scriptDefinition1 = @'
function X {
# Ok
Get-TransportRule |
Select-Object -Property @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }, @{N = 'RecipientDomainIs'; E = { ($_.RecipientDomainIs | Sort-Object) -join ', ' } }, BlindCopyTo |
ConvertTo-Html -Fragment

# After these lines will go one tab to the right
Get-TransportRule |
Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } } | ConvertTo-Html -Fragment

# After these lines will  go one more tab to the right
Get-TransportRule |
Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }
}

function Xx {

}
'@

Invoke-Formatter -ScriptDefinition $scriptDefinition1 -Settings $CodeFormattingOTBSSettings

and the result is :

function X {
    # Ok
    Get-TransportRule |
        Select-Object -Property @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }, @{N = 'RecipientDomainIs'; E = { ($_.RecipientDomainIs | Sort-Object) -join ', ' } }, BlindCopyTo |
        ConvertTo-Html -Fragment

    # After these lines will go one tab to the right
    Get-TransportRule |
        Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } } | ConvertTo-Html -Fragment

        # After these lines will  go one more tab to the right
        Get-TransportRule |
            Select-Object name, @{N = 'SenderDomainIs'; E = { ($_.SenderDomainIs | Sort-Object ) -join ', ' } }
        }

        function Xx {

        }

So I'm guessing that the issue should be closed here and I need to open a new issue in the PSScriptAnalyzer repo.

Correct?

[andyleejordan]

I'll get this transferred over instead!