PowerShell / PowerShell/PSScriptAnalyzer
PowerShell code formatting doesn't work as expected in VSCode
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Before submitting a bug report:
- Make sure you are able to repro it on the latest released version
- Perform a quick search for existing issues to check if this bug has already been reported
Steps to reproduce
I am using Visual Studio code to create PowerShell scripts and have "Format on Save" enabled. Sometimes I noticed that VSCode has issues with formatting braces correctly.
In the following file you can see an example:
https://github.com/dsccommunity/SharePointDsc/blob/1b7c1e10cd575c0e33e5268f49738d32a32e9078/SharePointDsc/DSCResources/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1#L475-L491
The opening brace of the If statement on line 476 is no aligning with closing brace on line 483. The same is true for the opening brace of the Else statement on line 485 and the closing brace on line 491.
My suspicion is that this has something to do with the code and braces in the code in these statements.
When I have this repo cloned locally, update the braces and then save, VSCode automatically reverts back to the current formatting. According to Tyler Leonhardt PSScriptAnalyzer is handling the formatting for VSCode, that is why I am raising the issue here.
Expected behavior
Both braces are placed on the same position in the line.
Actual behavior
The closing brace is moved two characters to the right, causing them to be misaligned.
Environment data
Name Value
PSVersion 5.1.19041.1023
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.19041.1023
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
(Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.19.1
VSCode 1.57.1, but am experiencing this for quite a while now.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue in VSCode with Format on Save using the linked SharePointDsc/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1 example and PSScriptAnalyzer 1.19.1. Trace the formatter’s handling of the if/else braces, add a regression test for the expected alignment, and verify that closing braces are no longer shifted two characters right.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, 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