VcfEdgeAtScale

1.0.3.1014

PSScriptAnalyzerSettings.psd1

                                @{

    # Analyzer profile for this module. Rule names match PSScriptAnalyzer defaults (PS* prefix).

    #

    # PSAvoidUsingConvertToSecureStringWithPlainText / PSAvoidUsingPlainTextForPassword /

    # PSAvoidUsingUsernameAndPasswordParams / UsePSCredentialType:

    #   Globally excluded because:

    #   (a) The 7 production functions that legitimately handle plain-text credentials are already

    #       suppressed per-function using [Diagnostics.CodeAnalysis.SuppressMessageAttribute]; those

    #       annotations remain as documentation of intent.

    #   (b) Pester It/BeforeAll blocks in test files are not function declarations, so

    #       [Diagnostics.CodeAnalysis.SuppressMessageAttribute] cannot be applied to them.

    #       A single global exclusion covers both production per-function suppressions and

    #       test fixture credentials.

    #   See each function's declaration in Private/Logging.ps1 and Private/Supervisor.ps1.

    #

    # PSAvoidUsingWriteHost:

    #   Suppressed because Write-LogMessage uses Write-Host for console color output and

    #   interactive prompts require it (Read-Host prompt coloring).

    #

    # PSUseBOMForUnicodeEncodedFile / PSUseSingularNouns:

    #   PSUseBOMForUnicodeEncodedFile is not applicable for cross-platform UTF-8 files.

    #   PSUseSingularNouns conflicts with established function names (e.g. Get-Datacenters).

    #

    # PSUseShouldProcessForStateChangingFunctions:

    #   All Set-*, New-*, Remove-*, Update-* functions in Private/ are internal helpers called

    #   only by orchestration functions that already implement SupportsShouldProcess. Requiring

    #   SupportsShouldProcess on every private helper adds noise without benefit because these

    #   functions are never called directly by end users and -WhatIf is handled at the entry point.

    #   NOTE: this suppression is global — any newly exported Set-*/New-*/Remove-*/Update-* cmdlets

    #   added to FunctionsToExport must manually declare [CmdletBinding(SupportsShouldProcess)].

    #

    # PSAvoidGlobalVars:

    #   Suppressed because Connect-Vcenter, Test-VcenterConnection, and Disconnect-Vcenter must

    #   read $Global:DefaultViServers and $Global:DefaultVIServer — PowerCLI's own session-state

    #   globals. There are no user-defined global variables in this module.

    #

    # PSReviewUnusedParameter:

    #   Some validation functions (e.g. Test-JsonLbVirtualServerIpCount) declare $ClustersToValidate

    #   and $InputData for uniform call-site compatibility with the validation dispatch loop in

    #   Test-JsonDeeperValidation, even when the function body only needs $SiteSpecsToValidate.

    #   This is intentional and documented in those functions' comment-based help.

    ExcludeRules = @(

        'PSAvoidGlobalVars',

        'PSAvoidUsingConvertToSecureStringWithPlainText',

        'PSAvoidUsingWriteHost',

        'PSReviewUnusedParameter',

        'PSUseBOMForUnicodeEncodedFile',

        'PSUseShouldProcessForStateChangingFunctions',

        'PSUseSingularNouns'

    )

}