PowerShell / PowerShell/PSScriptAnalyzer
PSPossibleIncorrectComparisonWithNull fails to work with typecasted variables
未关闭
还没有人认领这个 Issue。
Area - Rules
Issue - Enhancement
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 414
- 平均合并
- 13 小时 1 分钟
- 30 天内合并 PR
- 2
描述
Steps to reproduce
If you validate this script, it complains about PSPossibleIncorrectComparisonWithNull even though it is pretty clear $value must be a string.
Function Get-FooBar() {
return "foobar"
}
[string]$value = (Get-FooBar)
if ($value -eq $null) {
Write-Output 'value is $null'
} else {
Write-Output 'value is not $null'
}
Expected behavior
It works perfectly fine if the value is type-casted like this:
Function Get-FooBar() {
return "foobar"
}
$value = (Get-FooBar) -as [string]
if ($value -eq $null) {
Write-Output 'value is $null'
} else {
Write-Output 'value is not $null'
}
Actual behavior
So we get this error needlessly.
ERROR: test.ps1:9:5: PSPossibleIncorrectComparisonWithNull $null should be on the left side of equality comparisons.
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 6.0.2
PSEdition Core
GitCommitId v6.0.2
OS Linux 4.15.10-1.el7.elrepo.x86_64 #1 SMP Thu Mar 15 10:05:52 EDT 2018
Platform Unix
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.16.1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 PSPossibleIncorrectComparisonWithNull 规则开始,使用第一个 PowerShell 脚本重现警告,然后将其与 -as [string] 示例进行比较。跟踪该规则对显式类型转换变量的处理,并添加或更新覆盖范围,使示例中的安全比较不会发出警告,同时仍覆盖现有案例。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- powershell
- 领域
- tooling
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 48/100