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
分支
415
平均合併
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 摘要。