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

​
Description

PowerShell team best practices state cmdlets should use singular nouns and not plurals. Suppression allows you to suppress the rule for specific function names. For example: 
function Get-Elements {
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', 'Get-Elements')]
    Param()
}

​
Configuration

Rules = @{
    PSUseSingularNouns = @{
        Enable           = $true
        NounAllowList    = 'Data', 'Windows', 'Foos'
    }
}

​
Parameters

  • Enable: bool (Default value is $true) Enable or disable the rule during ScriptAnalyzer invocation.
  • NounAllowList: string[] (Default value is {'Data', 'Windows'}) Commands to be excluded from this rule. Data and Windows are common false positives and are excluded by default.

​
How

Change plurals to singular.

​
Examples

​
Problematic code

function Get-Files
{
    ...
}

​
Correct code

function Get-File
{
    ...
}

​
Source

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