powershell/PSDSCUseVerboseMessageInDSCResource

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

Property	Value
Severity	Information
Category	PSScriptAnalyzer
Default	Disabled in tally
Auto-fix	No

tally disables this rule by default because Desired State Configuration resources are out of scope for Dockerfile RUN analysis. Re-enable it with include = ["powershell/PSDSCUseVerboseMessageInDSCResource"] or by setting rules.powershell.PSDSCUseVerboseMessageInDSCResource.severity = "warning" in .tally.toml.

Description

Best practice recommends that additional user information is provided within commands, functions and scripts using Write-Verbose.

How

Make use of the Write-Verbose command.

Examples

Problematic code

Function Test-Function
{
    [CmdletBinding()]
    Param()
    ...
}

Correct code

Function Test-Function
{
    [CmdletBinding()]
    Param()
    Write-Verbose 'Verbose output'
    ...
}

Source

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

powershell/PSDSCUseIdenticalParametersForDSC

powershell/PSMisleadingBacktick

⌘I

​Description

​How

​Examples

​Problematic code

​Correct code

​Source

Description

How

Examples

Problematic code

Correct code

Source