Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.44 KB

AvoidUsingPositionalParameters.md

File metadata and controls

60 lines (42 loc) · 1.44 KB
Raw
description ms.custom ms.date ms.topic title
Avoid Using Positional Parameters
PSSA v1.22.0
02/13/2024
reference
AvoidUsingPositionalParameters

AvoidUsingPositionalParameters

** Severity Level: Information **

Description

Using positional parameters reduces the readability of code and can introduce errors. It is possible that a future version of the cmdlet could change in a way that would break existing scripts if calls to the cmdlet rely on the position of the parameters.

For simple cmdlets with only a few positional parameters, the risk is much smaller. To prevent this rule from being too noisy, this rule gets only triggered when there are 3 or more parameters supplied. A simple example where the risk of using positional parameters is negligible, is Test-Path $Path.

Configuration

Rules = @{
    PSAvoidUsingPositionalParameters = @{
        CommandAllowList = 'Join-Path', 'MyCmdletOrScript'
        Enable           = $true
    }
}

Parameters

CommandAllowList: string[] (Default value is @()')

Commands or scripts to be excluded from this rule.

Enable: bool (Default value is $true)

Enable or disable the rule during ScriptAnalyzer invocation.

How

Use full parameter names when calling commands.

Example

Wrong

Get-Command ChildItem Microsoft.PowerShell.Management

Correct

Get-Command -Noun ChildItem -Module Microsoft.PowerShell.Management