PowerShell / PowerShell/PSScriptAnalyzer

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

Offen
#1,142 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Issue - New Rule
Vorherrschende Sprache
C#
Sterne
2.2k
Forks
414
Ø Merge
13 Std. 1 Min.
Gemergte PRs (30 T.)
2

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie damit, die vorhandenen Analyzer-Regeln und Tests für PowerShell-Befehle zu finden; das Issue nennt Write-Progress und passende -Completed-Aufrufe, aber keine Dateien oder Einstiegspunkte. Klären Sie, wie sich Gültigkeitsbereichsgrenzen sowie begin/process/end-Blöcke verhalten sollen, und definieren Sie anschließend Tests, die gewöhnliche und asynchrone Befehlstypen abdecken, bevor Sie mit der Implementierung beginnen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, powershell
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.