PowerShell / PowerShell/PSScriptAnalyzer
Private parameters are reported as unused
未关闭
还没有人认领这个 Issue。
Issue - Enhancement
Up-for-Grabs
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 414
- 平均合并
- 13 小时 1 分钟
- 30 天内合并 PR
- 2
描述
Before submitting a bug report:
- Make sure you are able to repro it on the latest released version
- Perform a quick search for existing issues to check if this bug has already been reported
Steps to reproduce
Run the analyzer against this script.
Param (
[String] $private:var1
)
function Test-Second
{
# $var1 is not accessible because it was private to the script.
Write-Information -InformationAction "continue" "From script: $var1"
# $var2 is not private to the calling function so we can access it.
Write-Information -InformationAction "continue" "From caller: $var2"
}
function Test-NotGlobal
{
Param (
[String] $var2
)
$a = $var1 + " " + $var2
Write-Information -InformationAction "continue" "Concatenation: $a"
Test-Second
}
Test-NotGlobal $var1
Expected behavior
Expect no errors because $private:var1 and the use in the last line of $var1 are the same variable and $var1 is private to the script, as required.
Actual behavior
PS C:\Users\pauldsmith> Invoke-ScriptAnalyzer c:\temp\gvar.ps1
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSReviewUnusedParameter Warning gvar.ps1 2 The parameter 'private:var1' has been declared but not
used.
PS C:\Users\pauldsmith>
If an unexpected error was thrown then please report the full error details using e.g. $error[0] | Select-Object *
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.22621.963
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.22621.963
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.21.0
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先对 PowerShell 复现运行 Invoke-ScriptAnalyzer,并检查 PSReviewUnusedParameter 规则的实现和覆盖率。确认 private 参数及其最后一次使用被识别为同一个变量;完成标准是复现不产生未使用参数警告。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- powershell
- 领域
- tooling
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100