PowerShell / PowerShell/PSScriptAnalyzer
Rule `PSAvoidShouldContinueWithoutForce` doesn't enforce correct use of the `Force` parameter
未关闭
还没有人认领这个 Issue。
Up-for-Grabs
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 414
- 平均合并
- 13 小时 1 分钟
- 30 天内合并 PR
- 2
描述
Currently PSScriptAnalyzer shows a PSAvoidShouldContinueWithoutForce violation for any scripts using $PSCmdlet.ShouldContinue that do not include a $Force parameter.
However, once the parameter the violation is resolved; even if that parameter is never used elsewhere in the code.
Steps to reproduce
function Invoke-MVP {
[CmdletBinding(SupportsShouldProcess = $true)]
[OutputType('System.String')]
Param (
[Parameter()]
[switch]$Force # Including this parameter resolves the PSAvoidShouldContinueWithoutForce violation; even though we don't reference Force in the rest of the code
)
if ($PSCmdlet.ShouldContinue('Should I continue','Should I continue')) {
'I continued'
}
}
# ...
Invoke-ScriptAnalyzer -Path '.\Invoke-MVP.ps1'
Expected behavior
A violation of rule PSAvoidShouldContinueWithoutForce should occur.
Actual behavior
The code is deemed free of violations.
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.14409.1018
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.14409.1018
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.18.1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先定位 PSAvoidShouldContinueWithoutForce 规则的实现及其现有测试,然后使用报告中的 Invoke-MVP 示例重现该问题。当未使用的 Force 参数不再抑制违规,且有回归测试覆盖该情况时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp, powershell
- 领域
- tooling
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100