PowerShell / PowerShell/PSScriptAnalyzer

PSUseOutputTypeCorrectly: Fails when using multiple output types

未关闭
#1,289 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Area - Rules Issue - Bug
主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
2

描述

Steps to reproduce

The following code snippet returns to objects with different types.

function Get-Function
{
    [CmdletBinding()]
    [OutputType(
        [System.String],
        [System.UInt32])]
    param ()

    return [System.String] 'hello', [System.UInt32] 1
}

$myString, $myInt = Get-Function
$myString.GetType()
$myInt.GetType()

But when running the analyzer on this it hits rule PSUseOutputTypeCorrectly .

Invoke-ScriptAnalyzer -ScriptDefinition @'
function Get-Function
{
    [CmdletBinding()]
    [OutputType(
        [System.String],
        [System.UInt32])]
    param ()

    return [System.String] 'hello', [System.UInt32] 1
}
'@

Expected behavior

No rule should be hit since the OutputType contains two output types which is valid syntax according to this https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_functions_outputtypeattribute?view=powershell-5.1

Two or more output types could equal to System.Object[]. But preferably it should see if there are multiple output types, and then see how many return values there are.

Actual behavior

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSUseOutputTypeCorrectly            Information             9     The cmdlet 'Get-Function' returns an object of type '
                                                                  System.Object[]' but this type is not declared in the
                                                                   OutputType attribute.

Environment data

> $PSVersionTable


Name                           Value
----                           -----
PSVersion                      5.1.18890.1000
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.18890.1000
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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先使用 Invoke-ScriptAnalyzer 重现该示例,并跟踪 PSUseOutputTypeCorrectly 规则对多个 OutputType 值和返回值的处理方式。完成的标准是有效函数不再产生诊断,并且在该规则测试所在的所有位置添加回归覆盖。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp, powershell
领域
tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。