PowerShell / PowerShell/PSScriptAnalyzer
Powershell Code Formatter Removing Text From Lines
還沒有人認領這個 Issue。
- 主要語言
- C#
- 星號
- 2.2k
- 分支
- 414
- 平均合併
- 13 小時 1 分鐘
- 30 天內合併 PR
- 2
描述
Hi,
I am trying to track down an issue where the Powershell code formatter is run against a psm1 file but does not seem to do
anything at all. I started pasting individual functions of the psm1 file into a new file to see if perhaps it was confused by a certain piece of code. I have yet to establish why it does not appear to do anything on the original file at all. It did run on the new file but it messed up one function that contained the following line of code. I was able to replicate this issue by creating a new .psm1 file that only contains the string below and then running the Format Document against it
Code Before Running Formatter
Write-host "Error: File '$settingsfile' does not exist" -ForegroundColor Red
Code After Running Formatter
Write-Host "Error: File '$settingsfile'-ForegroundColor Red
What is odd is that if you run the line above through Invoke-Formatter, it does not mess up the result. But if you use SHIFT-ALT-F, it does. If you use Format Selection it does nothing in code. It was supposed to change Write-host to Write-Host.
Apart from the fact that it actually removes code it is not supposed to remove, what is the best way to debug this. The result returned by Invoke-Formatter does not seem to correspond what is put back in the psm1 file.
Visual Studio Code Version: 1.52.1
Powershell Extension: v2020.6.0
PSVersion 5.1.17763.1490
Windows Version: 10.0.17763.0 - Windows 2019
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從包含 Write-host 行的最小 .psm1 重現開始,並將 Invoke-Formatter 的輸出與 Visual Studio Code 中 Format Document 的結果進行比較。當格式化將 Write-host 變更為 Write-Host,且不移除結尾引號或 -ForegroundColor Red,同時兩種格式化路徑產生一致的結果時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- powershell, vscode
- 領域
- tooling
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100