PowerShell / PowerShell/PSScriptAnalyzer
PowerShell code formatting doesn't work as expected in VSCode
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- C#
- Estrelas
- 2.2k
- Forks
- 414
- Merge médio
- 13h 1min
- PRs com merge (30d)
- 2
Descrição
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.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Reproduza o problema no VSCode com Format on Save usando o exemplo vinculado de SharePointDsc/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1 e PSScriptAnalyzer 1.19.1. Rastreie como o formatador lida com as chaves de if/else, adicione um teste de regressão para o alinhamento esperado e verifique se as chaves de fechamento não são mais deslocadas dois caracteres para a direita.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- powershell, vscode
- Domínio
- developer-experience, tooling
- Tipo de issue
- Bug
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 42/100