PowerShell / PowerShell/PSScriptAnalyzer
PSUseOutputTypeCorrectly: Fails when using multiple output types
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia riproducendo l'esempio con Invoke-ScriptAnalyzer e traccia il modo in cui la regola PSUseOutputTypeCorrectly gestisce più valori di OutputType e i valori restituiti. Il lavoro è completato quando la funzione valida non produce più una diagnostica e viene aggiunta una copertura di regressione ovunque si trovino i test di questa regola.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, powershell
- Ambito
- tooling
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100