PowerShell / PowerShell/vscode-powershell

Incorrect indentation when passing a hashtable as a function argument

Open
#4,945 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Code Formatting Issue-Bug
Dominant language
TypeScript
Stars
1.9k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

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"
    }

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

No response

Logs

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue in a .ps1 file using the provided snippet and the Format Document command. Compare the expected and actual indentation around the hashtable passed to -ParameterObject; done means formatting preserves the nested indentation shown in the report. No source file or test entry point is identified in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, typescript, vscode
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.