Skip to content

UseCorrectCasing.md

Latest commit

 

History

History
73 lines (51 loc) · 1.63 KB

UseCorrectCasing.md

File metadata and controls

73 lines (51 loc) · 1.63 KB
description Use exact casing of cmdlet/function/parameter name.
ms.date 06/28/2023
ms.topic reference
title UseCorrectCasing

UseCorrectCasing

Severity Level: Information

Description

This is a style/formatting rule. PowerShell is case insensitive wherever possible, so the casing of cmdlet names, parameters, keywords and operators does not matter. This rule nonetheless ensures consistent casing for clarity and readability. Using lowercase keywords helps distinguish them from commands. Using lowercase operators helps distinguish them from parameters.

Configuration

Rules = @{
    PS UseCorrectCasing = @{
        Enable        = $true
        CheckCommands = $true
        CheckKeyword  = $true
        CheckOperator = $true
    }
}

Enable: bool (Default value is $false)

Enable or disable the rule during ScriptAnalyzer invocation.

CheckCommands: bool (Default value is $true)

If true, require the case of all operators to be lowercase.

CheckKeyword: bool (Default value is $true)

If true, require the case of all keywords to be lowercase.

CheckOperator: bool (Default value is $true)

If true, require the case of all commands to match their actual casing.

How

Use exact casing for type names.

Use exact casing of the cmdlet and its parameters, e.g. Invoke-Command { 'foo' } -RunAsAdministrator.

Use lowercase for language keywords and operators.

Example

Wrong

ForEach ($file IN get-childitem -recurse) {
    $file.Extension -Eq '.txt'
}

Correct

foreach ($file in Get-ChildItem -Recurse) {
    $file.Extension -eq '.txt'
}