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
派生
414
平均合并
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 摘要。