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/PSUseConsistentParametersKind is a PSScriptAnalyzer diagnostic emitted by tally for PowerShell snippets embedded in Dockerfiles.
PropertyValue
SeverityWarning
CategoryPSScriptAnalyzer
Auto-fixNo

​
Description

All functions should use the same pattern when defining parameters. Possible pattern types are:
  1. Inline 
    function f([Parameter()]$FirstParam) {
    return
}
  2. 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.