Add prefix setting for posh-git default prompt. #393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add Pesters tests for the prompt function. Update docs for the new prefix and the fact that abbreviate home dir is disabled by default.
dahlbyk
reviewed
Feb 2, 2017
README.md
Outdated
| > | ||
| ``` | ||
| You can also customize the default prompt prefix text e.g.: | ||
| ``` | ||
| $GitPromptSettings.DefaultPromptSuffix = '[$(hostname)] ' |
src/en-US/about_posh-git.help.txt
Outdated
| posh-git integrates Git and PowerShell with tab completion and Git | ||
| status summary information displayed in the PowerShell prompt. | ||
| posh-git integrates Git and PowerShell providing tab completion of Git | ||
| commands, remotes and branch names. It also provides Git status summary |
There was a problem hiding this comment.
"commands, branch names, paths and more"?
src/en-US/about_posh-git.help.txt
Outdated
| @@ -14,6 +15,10 @@ LONG DESCRIPTION | |||
| via the Get-GitStatus command. Then you can display the information in | |||
| your prompt however you would like. | |||
|
|
|||
| posh-git will install a prompt function if it detects the user does not | |||
| have their own customized prompt. This prompt displays Git status summary | |||
There was a problem hiding this comment.
Comma after "own," as in the readme?
src/en-US/about_posh-git.help.txt
Outdated
| POWERSHELL PROMPT | ||
| PowerShell generates its prompt by executing a function named "prompt", if | ||
| one exists. posh-git will install its prompt function if it detects the | ||
| user does not have their own, customized prompt fucntion. This prompt |
src/en-US/about_posh-git.help.txt
Outdated
| one exists. posh-git will install its prompt function if it detects the | ||
| user does not have their own, customized prompt fucntion. This prompt | ||
| displays the current working directory followed by git status summary | ||
| information if the current directory is located in a Git repository e.g.: |
README.md
Outdated
| @@ -5,7 +5,7 @@ | |||
|
|
|||
| posh-git is a PowerShell module that integrates Git and PowerShell by providing Git status summary information that can be displayed in the PowerShell prompt e.g.: | |||
src/en-US/about_posh-git.help.txt
Outdated
| For more information on customizing the posh-git default prompt or creating | ||
| your own prompt fuction see: | ||
| https://github.com/dahlbyk/posh-git/wiki/Customizing-Your-PowerShell-Prompt | ||
|
|
test/DefaultPrompt.Tests.ps1
Outdated
| Set-Location $PSScriptRoot | ||
|
|
||
| function global:git { | ||
| $cmdline = "$args" |
There was a problem hiding this comment.
Does $OFS = '' set above mess with this?
There was a problem hiding this comment.
More generally, is this mock git function something that should be defined in Shared?
Move $OFS='' to a more specific scope. Add $ForcePoshGitPrompt param to posh-git.psm1 to force load of the posh-git prompt. Moved git function to shared.ps1. Eventually when I can figure how to remove this global function, I'd like this function to be add in BeforeAll and removed in AfterAll for the tests that actually need to mock Git.
It would be nice with the ANSI support if PowerShell could render basic markdown in the console. But a converter would be nice too. Take a look at the change. I cleaned up the typos and tweaked the tests some more. There were failing when I ran them from PowerShell where I already had a prompt/settings/posh-git loaded. These changes make this scenario work although it leaves with the default posh-git prompt. |
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.
Add Pesters tests for the prompt function. Update docs for the new prefix and the fact that abbreviate home dir is disabled by default.