PowerShell / PowerShell/PSScriptAnalyzer

Write-Host should be closed within the scope it was created in, unless it is a Async command type

未關閉
#1,142 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

Issue - New Rule
主要語言
C#
星號
2.2k
分支
415
平均合併
13 小時 1 分鐘
30 天內合併 PR
2

描述

Summary of the new feature

Some times people don't properly close their Write-progress calls with a -Completed which can cause unexpected output, or "leftover" progress bars from commands that completed, but never closed their progress bars

Proposed technical implementation details (optional)

Write-Progress automatically stops showing open progress bars when execution is complete, but this means that if you are making an interface that does not properly close their Write-Progress progress bars with a Write-Progress -Activity $ActivityName -Completed then it stays open while other code is running, until execution stops.

It seems like in vanilla shell console, powershell can recognize that it is "done" (I'm guessing.... maybe something like the scope that created the Write-Progress is stopped? )

But if you do this in other environments, like ISE, then the Progress bars don't go away unless properly closed with a -Completed

Additionally there is the case that people who are running with something like -PercentComplete 100 but never closing.

A recommendation to close Write-Progress'es with a -Completed would effectively stop this problem

Possibly make sure each write-progress -Activity has a matching one with -Completed ? Not sure if there is a way to detect if it's closed in the same scope or if that might cause more problems

A potential problem for that would be things like People start it in the begin { } block write over time in the progress { } block, but not closing in the end { } block?

What is the latest version of PSScriptAnalyzer at the point of writing
As far as I can tell, it does nothing for this currently

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先找出針對 PowerShell 命令的現有 analyzer 規則和測試;該 issue 提到了 Write-Progress 和相符的 -Completed 呼叫,但沒有指出任何檔案或進入點。釐清範圍邊界以及 begin/process/end 區塊應如何運作,然後在實作前定義涵蓋一般命令類型和 async 命令類型的測試。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp, powershell
領域
tooling
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
20/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。