powershell/PSUseConsistentParametersKind

powershell/PSUseConsistentParametersKind is a PSScriptAnalyzer diagnostic emitted by tally for PowerShell snippets embedded in Dockerfiles.

Property	Value
Severity	Warning
Category	PSScriptAnalyzer
Auto-fix	No

Description

All functions should use the same pattern when defining parameters. Possible pattern types are:

Inline

function f([Parameter()]$FirstParam) {
    return
}

ParamBlock

function f {
    param([Parameter()]$FirstParam)
    return
}

In simple scenarios, both function definitions shown are considered to be equal. The purpose of this rule is to enforce consistent code style across the codebase.

How to Fix

Rewrite function so it defines parameters as specified in the rule

Examples

When the rule sets parameters definition kind to Inline:

# Correct
function f([Parameter()]$FirstParam) {
    return
}

# Incorrect
function g {
    param([Parameter()]$FirstParam)
    return
}

When the rule sets parameters definition kind to ParamBlock:

# Incorrect
function f([Parameter()]$FirstParam) {
    return
}

# Correct
function g {
    param([Parameter()]$FirstParam)
    return
}

Source

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

​Description

​How to Fix

​Examples

​Source

Description

How to Fix

Examples

Source