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, [Parameter(HelpMessage = 'Enter a specific provider name. The default is all currently loaded providers.')] [ArgumentCompleter({ (Get-PSProvider).name })] [ValidateScript({ (Get-PSProvider).Name -contains $_ })] [string]$ProviderName ) Write-Verbose "Starting $($MyInvocation.MyCommand)" #define a scriptblock to run for each provider $test = { Param($Provider) if ($host.name -match 'console') { "$([char]0x1b)[1;4;38;5;155m$($provider.name)$([char]0x1b)[0m" } else { $provider.name } #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) { if ($host.name -match 'console') { $syn = $syn -replace "\b$param\b", "$([char]0x1b)[1;38;5;213m$param$([char]0x1b)[0m" } else { #must be in the PowerShell ISE so don't use any ANSI formatting } } } $syn } #test script block if ($PSBoundParameters.ContainsKey('ProviderName')) { Write-Verbose "Testing with the $($ProviderName) Provider" Invoke-Command -ScriptBlock $test -ArgumentList (Get-PSProvider $ProviderName) } else { #process all currently loaded providers foreach ($provider in (Get-PSProvider)) { Write-Verbose "Testing with the $($provider.name) Provider" Invoke-Command -ScriptBlock $test -ArgumentList $provider } #foreach Provider } Write-Verbose "Ending $($MyInvocation.MyCommand)" } |