Incorrect indentation when passing a hashtable as a function argument

[Márton Balassa]

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

Formatting multi-line function calls with hashtable parameters produces incorrect indentation of the function call.

Example script:

function Dummy($ParameterObject) {

}

Dummy `
    -ParameterObject @{
        Property = "value"
    }

After formatting, the script looks like this:

function Dummy($ParameterObject) {

}

Dummy `
    -ParameterObject @{
    Property = "value"
}

Notice how the indentation of the function call is off after the -ParameterObject argument.

PowerShell Version

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

Name             : Visual Studio Code Host
Version          : 2024.3.1
InstanceId       : b3c9ca50-9b38-4bc7-9277-50ee2615c59a
UI               : System.Management.Automation.Internal.Host.InternalHostUserInterface
CurrentCulture   : en-GB
CurrentUICulture : en-GB
PrivateData      : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
DebuggerEnabled  : True
IsRunspacePushed : False
Runspace         : System.Management.Automation.Runspaces.LocalRunspace

Visual Studio Code Version

1.87.2
863d2581ecda6849923a2118d93a088b0745d9d6
x64

Extension Version

ms-vscode.powershell@2024.3.1

Steps to Reproduce

1. Create a new file with .ps1 extension
2. Paste the following snippet:

function Dummy($ParameterObject) {

}

Dummy `
    -ParameterObject @{
        Property = "value"
    }

3. Execute the Format Document command (Shift+Alt+F)

Visuals

No response

Logs

No response

[Justin Grote]

Likely an issue in scriptanalyzer, we can see if we can reproduce and an issue would need to be opened there.

As a workaround, have you considered using splatting syntax rather than backticks?

function Dummy($ParameterObject) { $ParameterObject.Property }

$dummyParam = @{
  ParameterObject = @{
    Property = 'value'
  }
}

Dummy @dummyParam

[Márton Balassa]

As a workaround, have you considered using splatting syntax

That was just an example minimal repro case. In reality I'm calling Azure PowerShell functions having all sorts of parameters.

[Justin Grote]

@BalassaMarton even in that case I would strongly recommend splatting as you can have conditional parameters, and overall make the invocation much more structured than using backticks with parameters.

Looks to me like the issue is at the PSScriptAnalyzer level, as shown here:

gmo psscriptanalyzer

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.22.0                psscriptanalyzer                    {Get-ScriptAnalyzerRule, Invoke-Formatter, Invoke…

So you will need to open the issue in scriptanalyzer and, when fixed and version released, will work its way to this repo to be fixed (you could also install an early release of psscriptanalyzer and the extension can use that)

EDIT: Sorry I initially misread the scriptanalyzer result
EDIT2: Nope, I did in fact read it correctly.