functions/Get-CommandSyntax.ps1


Function Get-CommandSyntax {
    [cmdletbinding()]
    [alias("gsyn")]
    [outputtype("System.String")]
    Param(
        [Parameter(
            Position = 0,
            Mandatory,
            HelpMessage = "Enter the name of a PowerShell cmdlet or function. Ideally it has been loaded into the current PowerShell session."
            )]
        [ValidateScript({ Get-Command -Name $_ })]
        [string]$Name
    )

    Write-Verbose "Starting $($MyInvocation.mycommand)"

    foreach ($provider in (Get-PSProvider)) {
        Write-Verbose "Testing with the $($provider.name) Provider"
        "$([char]0x1b)[1;4;38;5;155m$($provider.name)$([char]0x1b)[0m"
        #get first drive
        $path = "$($provider.drives[0]):\"
        Write-Verbose "..getting syntax"
        Push-Location
        Set-Location $path
        $syn = Get-Command -Name $Name -Syntax | Out-String

        Write-Verbose "..getting dynamic parameters"
        $get = Get-Command -Name $name

        $dynamic = ($get.parameters.GetEnumerator() | Where-Object { $_.value.IsDynamic }).key
        Pop-Location
        if ($dynamic) {
            Write-Verbose "...found $($dynamic.count) dynamic parameters"
            Write-Verbose "...$($dynamic -join ",")"
            foreach ($param in $dynamic) {
                $syn = $syn -replace "\b$param\b", "$([char]0x1b)[1;38;5;213m$param$([char]0x1b)[0m"
            }
        }
        $syn
    } #foreach Provider

    Write-Verbose "Ending $($MyInvocation.mycommand)"
}