PowerShell / PowerShell/PSScriptAnalyzer
PSUseCmdletCorrectly breaks on Write-Verbose -Verbose
未关闭
还没有人认领这个 Issue。
Area - Rules
Issue - Bug
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 414
- 平均合并
- 13 小时 1 分钟
- 30 天内合并 PR
- 2
描述
I'm getting a rule violation when we force Write-Verbose to have output like this:
Write-Verbose -Verbose "My Message"
Steps to reproduce
Invoke-ScriptAnalyzer -ScriptDefinition '
Write-Verbose -Verbose "Getting file list from $pwd"
Write-Warning -Verbose "Getting file list from $pwd"
Write-Error -Verbose "Getting file list from $pwd"
Write-Error -ErrorAction SilentlyContinue "Getting file list from $pwd"
' -IncludeRule PSUseCmdletCorrectly
Expected behavior
There are no violations.
Actual behavior
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSUseCmdletCorrectly Warning 2 Cmdlet 'Write-Verbose' may be used incorrectly. Please
check that all mandatory parameters are supplied.
PSUseCmdletCorrectly Warning 3 Cmdlet 'Write-Warning' may be used incorrectly. Please
check that all mandatory parameters are supplied.
I think it's significant that it has no problem with either of the Write-Error lines, but I have not looked at the code to understand what is happening ...
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.18362.1171
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.18362.1171
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.19.1
1.19.1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先,使用报告中的 PowerShell 代码片段,通过 Invoke-ScriptAnalyzer 和 PSUseCmdletCorrectly 规则重现该问题。跟踪 Write-Verbose 和 Write-Warning 的检查方式,然后验证重现不会产生任何违规,同时现有的 Write-Error 用例仍然得到覆盖。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp, powershell
- 领域
- tooling
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 38/100