Fix help paging issues on macOS/Linux and with custom pager that takes arguments#9033
Merged
TravisEz13 merged 6 commits intoPowerShell:masterfrom Apr 10, 2019
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Fix #7175 by using
Out-String -Stream -Widthbefore piping to an application. This improves the help experience on macOS and Linux by ensuring lines of help text wrap properly for the given console width.Fix #8912 by using the PS tokenizer to separate the pager command from arguments if both are specified in $env:PAGER. Also ensures that there is no PowerShell interpretation of arguments to an application by using the stop parsing operator.
PR Context
The current reading experience of all help topics on macOS and Linux is sub-par giving PowerShell Core a bit of a black eye on those platforms. See #7175 for images of what this looks like.
Specify a custom pager with arguments works in v6.1 but is broken in v6.2. This PR fixes this issue - #8912.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.[feature]to your commit messages if the change is significant or affects feature tests