AvoidShouldContinueWithoutForce

Severity Level: Warning

Default state: Always enabled

Description

This rule detects functions that use ShouldContinue without a Force parameter. Functions that use ShouldContinue should have a boolean Force parameter to allow users to bypass the confirmation prompt.

When using ShouldContinue in advanced functions, call it after the ShouldProcess method returns $true.

To learn more, see about_Functions_CmdletBindingAttribute and about_Functions_Advanced_Methods.

Example

Noncompliant

Function Test-ShouldContinue
{
    [CmdletBinding(SupportsShouldProcess=$true)]
    Param
    (
        $MyString = 'blah'
    )

    if ($PsCmdlet.ShouldContinue('ShouldContinue Query', 'ShouldContinue Caption'))
    {
        ...
    }
}

Compliant

Function Test-ShouldContinue
{
    [CmdletBinding(SupportsShouldProcess=$true)]
    Param
    (
        $MyString = 'blah',
        [Switch]$Force
    )

    if ($Force -or $PsCmdlet.ShouldContinue('ShouldContinue Query', 'ShouldContinue Caption'))
    {
        ...
    }
}

Configure rule

This rule is always enabled and isn't configurable. Use one of the following methods to avoid using this rule:

• Create a custom rule configuration file to include only the rules you want or exclude the rules you don't want.
• Add the appropriate rule suppression attributes to your code to suppress the rule for specific code blocks. For more information, see the Suppressing rules section of Using PSScriptAnalyzer.