Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tally.wharflab.com/llms.txt

Use this file to discover all available pages before exploring further.

powershell/PSUseSupportsShouldProcess is a PSScriptAnalyzer diagnostic emitted by tally for PowerShell snippets embedded in Dockerfiles.
PropertyValue
SeverityWarning
CategoryPSScriptAnalyzer
Auto-fixNo

​
Description

This rule discourages manual declaration of WhatIf and Confirm parameters in a function/cmdlet. These parameters are, however, provided automatically when a function declares a CmdletBinding attribute with SupportsShouldProcess as its named argument. Using SupportsShouldProcess not only provides these parameters but also some generic functionality that allows the function/cmdlet authors to provide the desired interactive experience while using the cmdlet.

​
Examples

​
Problematic code

function foo {
    param(
        $param1,
        $Confirm,
        $WhatIf
    )
}

​
Correct code

function foo {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        $param1
    )
}

​
Source

This rule documentation is adapted from Microsoft’s PSScriptAnalyzer documentation for UseSupportsShouldProcess, licensed under CC BY 4.0.