PowerShell / PowerShell/PSScriptAnalyzer
Write-Host should be closed within the scope it was created in, unless it is a Async command type
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando le regole e i test esistenti dell’analizzatore per i comandi PowerShell; l’issue nomina Write-Progress e le chiamate -Completed corrispondenti, ma non indica file o punti di ingresso. Chiarisci come devono comportarsi i limiti dell’ambito e i blocchi begin/process/end, quindi definisci test che coprano i tipi di comando ordinari e asincroni prima dell’implementazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, powershell
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100