Skip to content

Add Help proxy function for non-Windows platforms #19972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityapatwardhan merged 3 commits into from
Jul 17, 2023
Merged

Add Help proxy function for non-Windows platforms #19972

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6946f3b
Add Help proxy function for non-Windows
sdwheeler Jul 14, 2023
346507b
Update src/System.Management.Automation/engine/InitialSessionState.cs
adityapatwardhan Jul 17, 2023
e63c002
Fix build
adityapatwardhan Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 147 additions & 15 deletions src/System.Management.Automation/engine/InitialSessionState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4126,16 +4126,7 @@ internal static string GetExecFunctionText()
}
#endif

/// <summary>
/// This is the default function to use for man/help. It uses
/// splatting to pass in the parameters.
/// </summary>
internal static string GetHelpPagingFunctionText()
{
// We used to generate the text for this function so you could add a parameter
// to Get-Help and not worry about adding it here. That was a little slow at
// startup, so it's hard coded, with a test to make sure the parameters match.
return @"
internal const string WindowsHelpFunctionText = @"
<#
.FORWARDHELPTARGETNAME Get-Help
.FORWARDHELPCATEGORY Cmdlet
Expand Down Expand Up @@ -4209,14 +4200,132 @@ .FORWARDHELPCATEGORY Cmdlet
elseif ($help -ne $null)
{
# By default use more on Windows and less on Linux.
if ($IsWindows) {
$pagerCommand = 'more.com'
$pagerArgs = $null
$pagerCommand = 'more.com'
$pagerArgs = $null

# Respect PAGER environment variable which allows user to specify a custom pager.
# Ignore a pure whitespace PAGER value as that would cause the tokenizer to return 0 tokens.
if (![string]::IsNullOrWhitespace($env:PAGER)) {
if (Get-Command $env:PAGER -ErrorAction Ignore) {
# Entire PAGER value corresponds to a single command.
$pagerCommand = $env:PAGER
$pagerArgs = $null
}
else {
# PAGER value is not a valid command, check if PAGER command and arguments have been specified.
# Tokenize the specified $env:PAGER value. Ignore tokenizing errors since any errors may be valid
# argument syntax for the paging utility.
$errs = $null
$tokens = [System.Management.Automation.PSParser]::Tokenize($env:PAGER, [ref]$errs)

$customPagerCommand = $tokens[0].Content
if (!(Get-Command $customPagerCommand -ErrorAction Ignore)) {
# Custom pager command is invalid, issue a warning.
Write-Warning ""Custom-paging utility command not found. Ignoring command specified in `$env:PAGER: $env:PAGER""
}
else {
# This approach will preserve all the pagers args.
$pagerCommand = $customPagerCommand
$pagerArgs = if ($tokens.Count -gt 1) {
$env:PAGER.Substring($tokens[1].Start)
}
else {
$null
}
}
}
}

$pagerCommandInfo = Get-Command -Name $pagerCommand -ErrorAction Ignore
if ($pagerCommandInfo -eq $null) {
$help
}
elseif ($pagerCommandInfo.CommandType -eq 'Application') {
# If the pager is an application, format the output width before sending to the app.
$consoleWidth = [System.Math]::Max([System.Console]::WindowWidth, 20)

if ($pagerArgs) {
$help | Out-String -Stream -Width ($consoleWidth - 1) | & $pagerCommand $pagerArgs
}
else {
$help | Out-String -Stream -Width ($consoleWidth - 1) | & $pagerCommand
}
}
else {
$pagerCommand = 'less'
$pagerArgs = '-s','-P','Page %db?B of %D:.\. Press h for help or q to quit\.'
# The pager command is a PowerShell function, script or alias, so pipe directly into it.
$help | & $pagerCommand $pagerArgs
}
}
";

internal const string UnixHelpFunctionText = @"
<#
.FORWARDHELPTARGETNAME Get-Help
.FORWARDHELPCATEGORY Cmdlet
#>
[CmdletBinding(DefaultParameterSetName='AllUsersView', HelpUri='https://go.microsoft.com/fwlink/?LinkID=113316')]
param(
[Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
[string]
${Name},

[string]
${Path},

[ValidateSet('Alias','Cmdlet','Provider','General','FAQ','Glossary','HelpFile','ScriptCommand','Function','Filter','ExternalScript','All','DefaultHelp','DscResource','Class','Configuration')]
[string[]]
${Category},

[Parameter(ParameterSetName='DetailedView', Mandatory=$true)]
[switch]
${Detailed},

[Parameter(ParameterSetName='AllUsersView')]
[switch]
${Full},

[Parameter(ParameterSetName='Examples', Mandatory=$true)]
[switch]
${Examples},

[Parameter(ParameterSetName='Parameters', Mandatory=$true)]
[string[]]
${Parameter},

[string[]]
${Component},

[string[]]
${Functionality},

[string[]]
${Role},

[Parameter(ParameterSetName='Online', Mandatory=$true)]
[switch]
${Online})

# Display the full help topic by default but only for the AllUsersView parameter set.
if (($psCmdlet.ParameterSetName -eq 'AllUsersView') -and !$Full) {
$PSBoundParameters['Full'] = $true
}

# Linux need the default
$OutputEncoding = [System.Console]::OutputEncoding

$help = Get-Help @PSBoundParameters

# If a list of help is returned or AliasHelpInfo (because it is small), don't pipe to more
$psTypeNames = ($help | Select-Object -First 1).PSTypeNames
if ($psTypeNames -Contains 'HelpInfoShort' -Or $psTypeNames -Contains 'AliasHelpInfo')
{
$help
}
elseif ($help -ne $null)
{
# By default use more on Windows and less on Linux.
$pagerCommand = 'less'
$pagerArgs = '-s','-P','Page %db?B of %D:.\. Press h for help or q to quit\.'

# Respect PAGER environment variable which allows user to specify a custom pager.
# Ignore a pure whitespace PAGER value as that would cause the tokenizer to return 0 tokens.
Expand Down Expand Up @@ -4267,8 +4376,31 @@ .FORWARDHELPCATEGORY Cmdlet
}
}
";

/// <summary>
/// This is the default function to use for man/help. It uses
/// splatting to pass in the parameters.
/// </summary>
#if !UNIX
internal static string GetHelpPagingFunctionText()
{
// We used to generate the text for this function so you could add a parameter
// to Get-Help and not worry about adding it here. That was a little slow at
// startup, so it's hard coded, with a test to make sure the parameters match.
return WindowsHelpFunctionText;
}

#else
internal static string GetHelpPagingFunctionText()
{
// We used to generate the text for this function so you could add a parameter
// to Get-Help and not worry about adding it here. That was a little slow at
// startup, so it's hard coded, with a test to make sure the parameters match.
// This version removes the -ShowWindow parameter since it is not supported on Linux.
return UnixHelpFunctionText;
}
#endif

internal static string GetMkdirFunctionText()
{
return @"
Expand Down