PowerShell / PowerShell/PSScriptAnalyzer

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

Abierto
#1,142 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Issue - New Rule
Lenguaje dominante
C#
Estrellas
2.2k
Forks
414
Merge medio
13 h 1 min
PR fusionados (30 d)
2

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando las reglas y pruebas existentes del analizador para los comandos de PowerShell; el issue menciona Write-Progress y las llamadas -Completed correspondientes, pero no indica archivos ni puntos de entrada. Aclara cómo deben comportarse los límites de ámbito y los bloques begin/process/end, y después define pruebas que cubran tipos de comandos ordinarios y asíncronos antes de la implementación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp, powershell
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.