PowerShell / PowerShell/PSScriptAnalyzer
PowerShell code formatting doesn't work as expected in VSCode
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Riproducete il problema in VSCode con Format on Save utilizzando l’esempio collegato SharePointDsc/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1 e PSScriptAnalyzer 1.19.1. Tracciate la gestione da parte del formattatore delle parentesi graffe di if/else, aggiungete un test di regressione per l’allineamento previsto e verificate che le parentesi graffe di chiusura non vengano più spostate di due caratteri verso destra.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- powershell, vscode
- Ambito
- developer-experience, tooling
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100