indented-automation / indented.scriptanalyzerrules Goto Github PK

If the rule is testing a function hat has a parameter with a type that is not loaded into the session the rule fails on all parameters in all examples.

For example if having this parameter:

param
(
    [Parameter()]
    [Microsoft.SqlServer.Management.Smo.Server]
    $SqlServerObject
)

This row will return the function but the property Parameters will be $null

which result in that this evaluation always return $true

Suggest adding a error message when $null -eq $functionInfo.Parameters saying something like "Parameters of the function X could not be parsed, this can for example be due to that a type that is used by a parameter is not loaded into the session.".

I worked around this by loading stubs classes before running Invoke-ScriptAnalyzer.

When testing the following code

`
function Start-Test {
<#
.SYNOPSIS
Test program

.DESCRIPTION
Test program to demonstrate ScriptAnalyzerRules doesn't accept splatted examples

.EXAMPLE
    $testSplat = @{
        'Parameter1' = "1"
    }
    Start-Test @testSplat

#>
[cmdletbinding()]
param (
    [parameter(Mandatory = $true, HelpMessage = "Parameter1")]
    [String]$Parameter1
)

Write-Host $Parameter1

}
`

using the command Invoke-ScriptAnalyzer -Path .\SplatExamples.psm1 -CustomRulePath c:\gitrepos\ScriptAnalyzerRules\Indented.CodingConventions\

the command returns

Unable to determine parameter set used by example 1 for the function Start-Test

however the splat is valid and the function works as intended