PowerShell / PowerShell/PSScriptAnalyzer
Variables, defined with "-Option AllScope", in Nested Function reports "assigned but never used".
还没有人认领这个 Issue。
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 414
- 平均合并
- 13 小时 1 分钟
- 30 天内合并 PR
- 2
描述
Issue Description
I'm learning PowerShell, and also new to Visual Studio Code, and ran into a situation where it would be useful to create nested functions that access the parent function's variables. To my pleasant surprise PowerShell can do this and I created the below code to try it out. But Visual Studio Code continues to complain "The variable 'Data' is assigned but never used." and "The variable 'Return' is assigned but never used." But PowerShell itself seems to be quite happy with the code and produces the results I expected.
It appears that Visual Studio code is not recognizing the work that "Set-Variable", with the "AllScope" option, does in making these variables accessible throughout the GetMatchingIndex method (I wouldn't be surprised if "AllScope" makes it accessible outside the class - coming from a C# background, PowerShell does some really weird things).
If VSCode is working correctly, and there really are 2 bugs in my code, then I guess I need someone to explain how to fix the code.
class FERMI { # ForEachReturnMatchingIndex
[string[]]$CharSets
FERMI() {
$this.CharSets = 'ab', 'cd', 'ef', 'gh'
}
[int] GetMatchingIndex([string]$StringToFind) {
Write-Host
Set-Variable -Name ItemIndex, UpperOuterBounds, Data, Return -Option AllScope
[int]$Return = [int]$ItemIndex = -1
$UpperOuterBounds = $this.CharSets.Length
function AbleToGetAnotherItem {
[OutputType([bool])]
param ()
if ($atgaiReturn = ++$ItemIndex -lt $UpperOuterBounds) { $Data = $this.CharSets[$ItemIndex]}
return $atgaiReturn
}
function ProcessData {
Write-Host "Data: $Data, Index: $ItemIndex"
if($Data -eq $StringToFind){
$Return = $ItemIndex
}
}
While (AbleToGetAnotherItem) {
ProcessData
}
return $Return
}
}
[FERMI] $MyFERMI = [FERMI]::New()
Write-Host "ef: $($MyFERMI.GetMatchingIndex('ef'))"
Write-Host "cd: $($MyFERMI.GetMatchingIndex('cd'))"
Write-Host "ij: $($MyFERMI.GetMatchingIndex('ij'))"
Write-Host "gh: $($MyFERMI.GetMatchingIndex('gh'))"
Write-Host "ab: $($MyFERMI.GetMatchingIndex('ab'))"
Environment Information
Visual Studio Code
| Name | Version |
|---|---|
| Operating System | Windows_NT x64 10.0.19042 |
| VSCode | 1.55.2 |
| PowerShell Extension Version | 2021.2.2 |
PowerShell Information
| Name | Value |
|---|---|
| PSVersion | 7.1.3 |
| PSEdition | Core |
| GitCommitId | 7.1.3 |
| OS | Microsoft Windows 10.0.19042 |
| Platform | Win32NT |
| PSCompatibleVersions | 1.0 2.0 3.0 4.0 5.0 5.1.10032.0 6.0.0 6.1.0 6.2.0 7.0.0 7.1.3 |
| PSRemotingProtocolVersion | 2.3 |
| SerializationVersion | 1.1.0.1 |
| WSManStackVersion | 3.0 |
Visual Studio Code Extensions
Visual Studio Code Extensions(Click to Expand)
| Extension | Author | Version |
|---|---|---|
| powershell | ms-vscode | 2021.2.2 |
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先,使用报告中所述的 PowerShell 和 VS Code 扩展版本运行随附的 FERMI 复现,然后检查 analyzer 如何跟踪在嵌套函数中通过 Set-Variable -Option AllScope 创建的变量。完成的标准是:诊断能够正确计入这些变量的使用情况,或者 issue 清楚地说明这些警告为何有效。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- powershell, vscode
- 领域
- tooling
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100