PowerShell / PowerShell/vscode-powershell

Formatting code with 2 spaces after a parenthesis, eats up all the code

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

Nobody has claimed this yet.

Area-Code Formatting Issue-Bug Needs: Maintainer Attention
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

if you try to format a code that has a multiline parenthesis, and 2 spaces before the first command argument after the closing parenthesis, the code disappears from the 3 character of the first line, to the argument that follows the double space.

PowerShell Version
Name                           Value
----                           -----
PSVersion                      7.4.0
PSEdition                      Core
GitCommitId                    7.4.0
OS                             Microsoft Windows 10.0.22635
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          : 2023.8.0
InstanceId       : 8afbe18b-7cbc-4fe9-b17d-ed231278a68a
UI               : System.Management.Automation.Internal.Host.InternalHostUserInterface
CurrentCulture   : en-US
CurrentUICulture : en-US
PrivateData      : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
DebuggerEnabled  : True
IsRunspacePushed : False
Runspace         : System.Management.Automation.Runspaces.LocalRunspace
Visual Studio Code Version
1.85.1
0ee08df0cf4527e40edc9aa28f4b5bd38bbff2b2
x64
Extension Version
ms-vscode.powershell@2023.8.0
Steps to Reproduce

try to format this (note the TWO spaces before -RepeatHeader):

$running | Format-Table -Property (
    'id',
    'name'
)  -RepeatHeader -AutoSize -Wrap

it becomes:

$r-RepeatHeader -AutoSize -Wrap
Visuals

https://github.com/PowerShell/vscode-powershell/assets/18366087/1297308d-59d8-49e4-acbb-5542d711d899

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 formatter failure in Visual Studio Code with the PowerShell snippet, paying attention to the two spaces after the closing parenthesis. Trace the PowerShell extension's formatting path from that reproduction. Done means formatting preserves the full command and its arguments instead of producing $r-RepeatHeader -AutoSize -Wrap; no test or source file is named in the issue.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.