Show AheadyBy/BehindBy counts based on configuration #256

drawfour · 2016-02-19T19:41:23Z

Add prompt setting BranchBehindAndAheadDisplay, which operates as follows:

If only behind or ahead:
    If set to "Full" or "Compact", display count along with appropriate arrow, otherwise just show the arrow

If both behind and ahead:
    If set to "Full", then display count along with arrow indicating direction of behind/ahead
    If set to "Compact", display the behind count immediately next to double-arrow, then ahead count
    If set to "Minimal" (or not recognized), display the old behavior of just the double-arrow.

Add prompt setting BranchBehindAndAheadDisplay: If only behind or ahead,: If set to "Full" or "Compact", display count along with appropriate arrow, otherwise just show the arrow If both behind and ahead: If set to "Full", then display count along with arrow indicating direction of behind/ahead If set to "Compact", display the behind count immediately next to double-arrow, then ahead count If set to "Minimal" (or not recognized), display the old behavior of just the double-arrow.

paulmarsy · 2016-02-19T20:11:08Z

Would there be interest in a "ColourCoded" display option, where the behind by arrow's colour changes based upon how many commits it is behind by?

Say magenta if it's behind by 1, dark magenta 2-4, red 5-10, dark red 10+?

That would convey an indication of how behind the branch is without making the prompt any bigger if the exact count isn't of interest but more the general severity how how much it is behind by.

drawfour · 2016-02-19T21:21:34Z

Interesting idea. Each arrow (for Full mode) can be color coded as well, but Compact/Minimal mode only have one symbol. That can be changed according to the overall delta (i.e. sum of Ahead/Behind is the deciding factor). Or we could have a mode between "Compact" and "Minimal" that will show individual arrows for Ahead/Behind, with a color coded option - just no numbers.

bazzilic · 2016-02-20T04:31:29Z

It is better not to rely on colors to convey information as people are likely to have custom color schemes.

dahlbyk

Sorry to have ignored this for so long - looks really good! Left a few comments for your consideration. Thanks for bring it up-to-date!

dahlbyk · 2016-12-29T22:26:57Z

GitPrompt.ps1

@@ -82,6 +82,9 @@ $global:GitPromptSettings = New-Object PSObject -Property @{

    AutoRefreshIndex                            = $true

+    # Valid values are "Full", "Compact", and "Minimal"


Thoughts on defining an enum to represent the valid states?

I thought about it, but seemed like overkill to me, since nothing else uses enums yet, and the syntax for enums seems less Powershell-y than some weird hack. If enums were already used, I would have defined them that way. But I can add.

You don't need to use an enum but once we drop support on master for PS v2, you can use:

[ValidateSet('Compact','Full','Minimal')] $BranchBehindAndAheadDisplay = "Full"

PS v2 support can't be dropped soon enough. :-)

Unfortunately, that doesn't work because it's a set of properties being initialized, not a variable. We could move it outside the GitPromptSettings declaration as a special case, but that's kind of ugly.

Doh. Yeah, sometimes the narrow GitHub diff window bites me. :-)

For 1.0 we could consider converting $GitPromptSettings to a giant config function of doom, as @Jaykul proposed long ago.

That's an interesting approach. It does have the benefit of providing tab-completion/validation on each parameter.

That change that was proposed has a side effect of having to pass the same parameters that you've already changed to the config method, since the default value for the parameter is a hard-coded defined value. You could still save the settings in a variable/property bag for storing, and perhaps have the default value for the parameter be the value already in the property bag, so that once changed, it will be used for subsequent sets.

Or you can do the Add-Type -TypeDefinition method to create enums you need and a class that has a bunch of public properties. They won't have tab-completion, but they will have parameter validation.

Opened #340 for discussion, targeting 1.0.

dahlbyk · 2016-12-29T22:30:04Z

GitPrompt.ps1

@@ -82,6 +82,9 @@ $global:GitPromptSettings = New-Object PSObject -Property @{

    AutoRefreshIndex                            = $true

+    # Valid values are "Full", "Compact", and "Minimal"
+    BranchBehindAndAheadDisplay                 = "Full"


Not sure about defaulting to Full - we're already taking up more space than we used to. Then again, leaving the counts disabled by default means most people will never see them. Anyone else have an opinion?

That's exactly why I left it default to Full and then added the example showing how to make it Compact. I find that the staged files section takes way more space than the Full view, unless you're dealing with seriously out of sync branches.

dahlbyk · 2016-12-29T22:31:05Z

GitPrompt.ps1

-
-        if ($branchStatusSymbol) {
-            Write-Prompt  (" {0}" -f $branchStatusSymbol) -BackgroundColor $branchStatusBackgroundColor -ForegroundColor $branchStatusForegroundColor
+


Trailing whitespace!

dahlbyk · 2016-12-30T17:41:20Z

Works for me - belated thanks!

drawfour · 2016-12-30T17:55:58Z

Happy to contribute! I use this tool every day.

drawfour mentioned this pull request Feb 19, 2016

AheadBy and BehindBy on Prompt #203

Closed

Alan Bridgewater and others added 2 commits February 23, 2016 11:12

Update profile sample to correct variable name

830fe56

Merge branch 'master' into master

7fb166a

dahlbyk reviewed Dec 29, 2016

View reviewed changes

Alan Bridgewater and others added 2 commits December 29, 2016 14:50

Fix trailing whitespace :)

85ab3d7

Merge branch 'master' into master

b443b40

dahlbyk merged commit 7bb0f5e into dahlbyk:master Dec 30, 2016

dahlbyk mentioned this pull request Dec 31, 2016

Export function to manipulate GitPromptSettings #340

Closed

drawfour mentioned this pull request Dec 31, 2016

Display git tag name in the prompt #233

Closed

This was referenced Mar 23, 2019

Show ahead/behind counts lyze/posh-git-sh#37

Merged

BranchBehindAndAheadDisplay 'Minimal' Setting #670

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show AheadyBy/BehindBy counts based on configuration #256

Show AheadyBy/BehindBy counts based on configuration #256

drawfour commented Feb 19, 2016

paulmarsy commented Feb 19, 2016

drawfour commented Feb 19, 2016

bazzilic commented Feb 20, 2016

dahlbyk left a comment

dahlbyk Dec 29, 2016

drawfour Dec 29, 2016

rkeithhill Dec 29, 2016

drawfour Dec 30, 2016

rkeithhill Dec 30, 2016

dahlbyk Dec 30, 2016

rkeithhill Dec 31, 2016

drawfour Dec 31, 2016

dahlbyk Dec 31, 2016

dahlbyk Dec 29, 2016

drawfour Dec 29, 2016

dahlbyk Dec 29, 2016

dahlbyk commented Dec 30, 2016

drawfour commented Dec 30, 2016

		@@ -82,6 +82,9 @@ $global:GitPromptSettings = New-Object PSObject -Property @{

		AutoRefreshIndex = $true

		# Valid values are "Full", "Compact", and "Minimal"


		if ($branchStatusSymbol) {
		Write-Prompt (" {0}" -f $branchStatusSymbol) -BackgroundColor $branchStatusBackgroundColor -ForegroundColor $branchStatusForegroundColor

Show AheadyBy/BehindBy counts based on configuration #256

Show AheadyBy/BehindBy counts based on configuration #256

Conversation

drawfour commented Feb 19, 2016

paulmarsy commented Feb 19, 2016

drawfour commented Feb 19, 2016

bazzilic commented Feb 20, 2016

dahlbyk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dahlbyk commented Dec 30, 2016

drawfour commented Dec 30, 2016