PowerShell / PowerShell/PSScriptAnalyzer
PSUseOutputTypeCorrectly: Fails when using multiple output types
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 414
- Merge medio
- 13 h 1 min
- PR fusionados (30 d)
- 2
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza reproduciendo el ejemplo con Invoke-ScriptAnalyzer y rastrea cómo la regla PSUseOutputTypeCorrectly gestiona múltiples valores de OutputType y los valores devueltos. Se considera terminado cuando la función válida ya no produce un diagnóstico y se haya añadido cobertura de regresión dondequiera que se encuentren las pruebas de esta regla.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- csharp, powershell
- Área
- tooling
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100