循环调用Register-ArgumentCompleter生成错误参数补全问题排查

问题场景 #

我有一个包含动态派生枚举值的哈希表的模块，原本想通过Register-ArgumentCompleter实现参数补全。无法直接将模块函数的输入参数自动转换为枚举类型（该方式可正常启用补全），原因是希望动态派生枚举以避免用户手动管理枚举值，同时受限于.NET枚举的实现——需要支持含短横线、以数字开头的字符串及空值，而这些都是枚举不允许的。因此打算通过Register-ArgumentCompleter添加参数补全值作为替代方案。

将该方案作为脚本放在模块清单的ScriptsToProcess成员首位加载时，发现循环遍历哈希表键并调用Register-ArgumentCompleter时，设置的补全值不正确：循环内控制台输出的参数名和补全值均正确，但实际补全时所有参数都显示哈希表最后一个键对应的补全值（PS 7.2.5中显示b1 b2，Windows PowerShell 5.1.19041中显示c1 c2）。

复现代码 #

function test {param($a, $b, $c, $d )}

$ht = @{
    '1' = @('a', @('a1','a2'))
    '2' = @('b', @('b1','b2'))
    '3' = @('c', @('c1','c2'))
    '4' = @('d', @('d1','d2'))
}

Foreach ($enum in $ht.Keys){
    $paramName = $ht.$enum[0]
    $paramValue = $ht.$enum[1]

    write-host $paramName
    write-host $paramValue

    Register-ArgumentCompleter -CommandName test2 -ParameterName $paramName -ScriptBlock {$paramValue}
}

# 执行测试
# PS> test -a <tab>
# 预期显示a1 a2，实际显示最后一个键对应的补全值

问题原因与解决方法 #

核心原因 #

这不是PowerShell的Bug，而是闭包变量捕获的常见问题：循环中创建的所有ScriptBlock都引用同一个$paramValue变量，当循环结束后，该变量的值是最后一次迭代的结果，因此所有补全器都会返回最后一组值。此外，代码中还存在一个笔误：Register-ArgumentCompleter的-CommandName指定为test2，但定义的函数是test，这会导致补全器无法关联到目标函数。

解决方法 #

需要让每个ScriptBlock捕获当前迭代的补全值，而不是引用同一个循环变量。以下是两种可行的实现方式：

方式1：使用局部变量固定当前迭代值

在循环内部创建局部变量存储当前补全值，确保每个ScriptBlock捕获的是独立的变量实例：

function test {param($a, $b, $c, $d )}

$ht = @{
    '1' = @('a', @('a1','a2'))
    '2' = @('b', @('b1','b2'))
    '3' = @('c', @('c1','c2'))
    '4' = @('d', @('d1','d2'))
}

Foreach ($enum in $ht.Keys){
    $paramName = $ht.$enum[0]
    # 用局部变量存储当前迭代的补全值
    $currentCompletionValues = $ht.$enum[1]

    Register-ArgumentCompleter -CommandName test -ParameterName $paramName -ScriptBlock {
        param($wordToComplete, $commandAst, $cursorPosition)
        # 返回符合补全要求的CompletionResult对象
        $currentCompletionValues | ForEach-Object {
            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
        }
    }
}

方式2：动态创建ScriptBlock嵌入当前值

通过[scriptblock]::Create()动态生成脚本块，将当前迭代的补全值直接嵌入脚本块代码中，避免变量引用问题：

function test {param($a, $b, $c, $d )}

$ht = @{
    '1' = @('a', @('a1','a2'))
    '2' = @('b', @('b1','b2'))
    '3' = @('c', @('c1','c2'))
    '4' = @('d', @('d1','d2'))
}

Foreach ($enum in $ht.Keys){
    $paramName = $ht.$enum[0]
    $paramValue = $ht.$enum[1]

    # 动态生成包含当前补全值的脚本块
    $completionScript = [scriptblock]::Create(@"
        param(`$wordToComplete, `$commandAst, `$cursorPosition)
        @($($paramValue | ForEach-Object { "'$_'" })) | ForEach-Object {
            [System.Management.Automation.CompletionResult]::new(`$_, `$_, 'ParameterValue', `$_)
        }
"@)

    Register-ArgumentCompleter -CommandName test -ParameterName $paramName -ScriptBlock $completionScript
}

关键说明 #

• 两种方法都修复了变量引用问题，确保每个参数补全器使用对应迭代的补全值。
• 推荐使用方式1，代码更简洁易读，且避免了动态脚本生成的潜在安全风险。
• 必须修正-CommandName的笔误，确保补全器关联到正确的函数。

内容的提问来源于stack exchange，提问作者Blaisem