PowerShell / PowerShell/PSScriptAnalyzer
PSShouldProcess rule ignores ShouldContinue
Abierto
Nadie ha tomado este issue todavía.
Area - Rules
Issue - Bug
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 414
- Merge medio
- 13 h 1 min
- PR fusionados (30 d)
- 2
Descripción
Steps to reproduce
# File: c:\temp\Invoke-MVP.ps1
function Invoke-MVP {
[CmdletBinding(SupportsShouldProcess = $true)] # This line shows an exception
[OutputType('System.String')]
Param (
[Parameter()]
[switch]$Force # just to hide PSAvoidShouldContinueWithoutForce for this MVP
)
{
if ($PSCmdlet.ShouldContinue('Should I continue','Should I continue')) {
'I continued'
}
}
}
Invoke-ScriptAnalyzer -Path 'C:\temp\Invoke-MVP.ps1'
Expected behavior
No error; using ShouldContinue should be equivalent to using ShouldProcess (for which we don't see this issue).
Actual behavior
RuleName Severity ScriptName Line Message
-------- -------- -------------- ---- -------
PSShouldProcess Warning Invoke-MVP.ps1 2 'Invoke-POC' has the ShouldProcess attribute but does not
call ShouldProcess/ShouldContinue.
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.14409.1018
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.14409.1018
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
Comienza con la regla PSShouldProcess y reproduce la advertencia usando C:\temp\Invoke-MVP.ps1 mediante Invoke-ScriptAnalyzer. Traza cómo la regla detecta las llamadas a ShouldProcess y ShouldContinue; se considera terminado cuando la función proporcionada ya no produce una advertencia PSShouldProcess al llamar a ShouldContinue.
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
- 45/100