PowerShell / PowerShell/PSScriptAnalyzer
PowerShell code formatting doesn't work as expected in VSCode
まだ誰も着手していません。
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされた SharePointDsc/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1 の例と PSScriptAnalyzer 1.19.1 を使用し、VSCode で Format on Save によって問題を再現します。フォーマッターによる if/else の中括弧の処理を追跡し、期待される配置の回帰テストを追加して、閉じ中括弧が右に 2 文字ずれて配置されなくなったことを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- powershell, vscode
- 領域
- developer-experience, tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100