Update to prompt func to allow path/status order swap #544

rkeithhill · 2018-02-05T03:17:35Z

Plus a few other tweaks to clean up the default prompt function.

rkeithhill · 2018-02-05T03:23:55Z

Oops. Got some test failures to clean up.

rkeithhill · 2018-02-05T05:23:00Z

This would allow folks to more fully customize the default prompt. This is one example:

$settings = $global:GitPromptSettings
$settings.DefaultPromptAbbreviateHomeDirectory = $true
$settings.DefaultPromptWriteStatusFirst = $true
$settings.BeforeText.Text = '['
$settings.AfterText.Text  = '] '
$settings.DefaultPromptTimingFormat = "{0}ms:"
$settings.DefaultPromptPath.Text += "`n"
$settings.DefaultPromptDebug = "[DBG]: "
$settings.DefaultPromptDebug.ForegroundColor = [ConsoleColor]::Magenta
$settings.DefaultPromptSuffix.Text = '$(if ($hist = Get-History -Count 1) {$hist.id+1} else {1})' + $settings.DefaultPromptSuffix.Text

To get this form of prompt:

[rkeithhill/change-debugprompt ≡] ~\GitHub\dahlbyk\posh-git
180ms:4>

rkeithhill · 2018-02-10T18:25:30Z

src/PoshGitTypes.ps1


    [PoshGitTextSpan]$DefaultPromptPrefix       = ''
-    [PoshGitTextSpan]$DefaultPromptSuffix       = '$(''>'' * ($nestedPromptLevel + 1)) '
-    [PoshGitTextSpan]$DefaultPromptDebugSuffix  = ' [DBG]$(''>'' * ($nestedPromptLevel + 1)) '


FYI the duplication here of the $nestedPromptLevel code bothered me. So now we display in order (where [] designates optional text:

[ DPDebugSuffix][ DPTimingFormat]DPSuffix

rkeithhill · 2018-02-10T18:26:35Z

src/PoshGitTypes.ps1

    [bool]$DefaultPromptAbbreviateHomeDirectory = $false

+    [bool]$DefaultPromptEnableTiming            = $false
+    [PoshGitTextSpan]$DefaultPromptTimingFormat = ' {0}ms'


I don't envision too many folks using prompt timing at all. But for those of us that do, I prefer not to have the ms in there. This is pretty easy way to accomplish this.

rkeithhill · 2018-02-12T16:27:19Z

src/PoshGitTypes.ps1

@@ -141,12 +141,12 @@ class PoshGitTextSpan {
        }
        else {
            $bg = $this.BackgroundColor
-            if ($bg -and !(Test-VirtualTerminalSequece $bg)) {
+            if (($null -ne $bg) -and !(Test-VirtualTerminalSequece $bg)) {


FYI this allows you to set the value to 0 (black). Before, it would see the 0 as false in this condition and use the "default" color.

rkeithhill · 2018-02-16T05:19:28Z

@dahlbyk I think this is ready to go. OK if I merge it?

rkeithhill · 2018-02-18T05:12:49Z

A few more changes here that I'm proposing. I have been noodling on how to make it simpler to switch path/status order (fewer settings requiring tweaks) and how to make it simpler to switch to a two-line prompt.

For this, I think it is helpful to see the current and proposed prompt layout. Note [] represent parts of the prompt that may not always be displayed:

Current prompt layout:

Default config:
{DPPrefix}{DPPath}[{BeforeText}{Status}{AfterText}][{DPDebug}][{DPTimingFormat}]{DPSuffix}

Status first config:
{DPPrefix}[{BeforeText}{Status}{AfterText}]{DPPath}[{DPDebug}][{DPTimingFormat}]{DPSuffix}


Proposed change:

Default config:
{DPPrefix}{DPPath}{PathStatusSep}[{BeforeStatus}{Status}{AfterStatus}]{DPMiddle}[{DPDebug}][{DPTimingFormat}]{DPSuffix}

Status first config:
{DPPrefix}[{BeforeStatus}{Status}{AfterStatus}]{PathStatusSep}{DPPath}{DPMiddle}[{DPDebug}][{DPTimingFormat}]{DPSuffix}

The above changes (corresponding to the commit I'm getting ready to push, gives us some nice flexibilty.

Is someone wants to swap path/status, then they simply set (no need to fiddle with both BeforeStatus and AfterStatus):

$global:GitPromptSettings.DefaultPromptWriteStatusFirst = $true

BTW I've rename a few of the stettings that had Text in the name because it was really weird to see BeforeText.Text = '[' and likely misleading as well. That is, folks would be tempted to assign like so BeforeText = '[' which works but wipes out any previously set fg/bg colors.

If they want a two line prompt:

$global:GitPromptSettings.DefaultPromptMiddle.Text = '`n'

I also have the default prompt, when in ANSI mode, saving the escaped prompt string to the global variable PoshGitLastPrompt. I figure this will come in handy in debug scenarios. Here's an example of what that looks like on PS Core:

~\GitHub\rkeithhill\PowerShell [master ≡ +1 ~0 -0 !] [DBG]:>> $PoshGitLastPrompt
~\GitHub\rkeithhill\PowerShell `e[93m[`e[0m`e[96mmaster`e[0m`e[96m ≡`e[0m`e[31m`e[49m +1`e[0m`e[31m`e[49m ~0`e[0m`e[31m`e[49m -0`e[0m`e[31m !`e[0m`e[93m]`e[0m`e[95m [DBG]:`e[0m>>

rkeithhill · 2018-02-18T05:27:20Z

FYI, this is the prompt config I'm currently running with:

$global:GitPromptSettings.DefaultPromptWriteStatusFirst = $true
$global:GitPromptSettings.DefaultPromptMiddle.Text = '`n$([DateTime]::now.ToString("MM-dd HH:mm:ss"))'
$global:GitPromptSettings.DefaultPromptMiddle.ForegroundColor = 0x7f7f7f
$global:GitPromptSettings.DefaultPromptEnableTiming = $true
$GitPromptSettings.DefaultPromptSuffix = ' $((Get-History -Count 1).id + 1)$(">" * ($nestedPromptLevel + 1)) '

This gives me:

Note: the number right before the > char is the history id number.

rkeithhill · 2018-03-24T03:19:55Z

@dahlbyk Any objections if I go ahead and merge this? Since it is still beta it would be good to get some feedback on the DefaultPrompt setting changes.

Add $global:PoshGitLastPrompt for ANSI escaped prompt str

dahlbyk

So, first and foremost: sorry this sat unanswered for two months. 😭

That said, I love the changes! I squashed up a few of the commits to reduce the code churn a bit, and left a few questions/comments.

And, of course, the build failed with "Unable to locate package powershell".

Note: the number right before the > char is the history id number.

Man, I did something like this forever ago and completely forgot about it. 🥂

dahlbyk · 2018-04-17T02:51:25Z

test/DefaultPrompt.Tests.ps1

        [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssigments', '')]
-        $nonRepoRegex = '^PowerShell \d+\.\d+\.\d+(\.\d+|-\S+)? \(\d+\)$'
+        $nonRepoRegex = '^PowerShell \d+\.\d+\.\d+(\.\d+|-\S+)? \d\d-bit \(\d+\)$'


These are going to break when we get to 128-bit processors.

Indeed. :-)

dahlbyk · 2018-04-17T03:06:28Z

test/DefaultPrompt.Tests.ps1

-            $res = [string](&$prompt 6>&1)
-            $res | Should BeExactly "${env:HOME}> "
+            $res = &$prompt
+            "$res" | Should BeExactly "${env:HOME}> "


Can you help me understand why sometimes you use [string](&$prompt 6>&1) and others you use this version?

dahlbyk · 2018-04-17T03:08:28Z

src/PoshGitTypes.ps1

@@ -259,6 +260,7 @@ class PoshGitPromptSettings {

    [PoshGitTextSpan]$DefaultPromptPrefix       = ''
    [PoshGitTextSpan]$DefaultPromptPath         = '$(Get-PromptPath)'
+    [PoshGitTextSpan]$DefaultPromptMiddle       = ''


Middle's a bit vague... maybe DefaultPromptBeforeSuffix?

Yeah, Middle is a bit vague. OTOH this section isn't always before the suffix i.e. if Debug or Timing is enabled this text appears before that. That said, in most cases (including the default) it is before the suffix.

I guess I was thinking of Debug/Timing as part of the suffix.

I can make that change but not tonight - getting late and I have VSCode-powershell PR to finish up. I can get to this tomorrow though as I really would like to get this in for beta 2. For somewhat selfish reasons I'm excited about this PR as it allows me to not have to define a custom prompt function anymore. :-)

dahlbyk · 2018-04-17T03:13:25Z

src/posh-git.psm1

+    # Write default prompt middle if not empty.
+    if ($settings.DefaultPromptMiddle.Text) {
+        $promptMiddle = [PoshGitTextSpan]::new($settings.DefaultPromptMiddle)
+        $promptMiddle.Text = $ExecutionContext.SessionState.InvokeCommand.ExpandString($promptMiddle.Text)


We do this enough, I wonder if it would be worth supporting [PoshGitTextSpan]::Expand($settings.DefaultPromptMiddle)? (Or add [bool]$expand = $false to the ctor?)

If we include the empty check, we could replace this whole block with just...

$prompt += Write-Prompt [PoshGitTextSpan]::Expand($settings.DefaultPromptMiddle)

That is acting kind of like a ctor. Maybe we could add a parameter to the ctor e.g.:

$prompt += Write-Prompt [PoshGitTextSpan]::new($settings.DefaultPromptMiddle, $ExecutionContext)

Or perhaps even better (shorter to type anyway):

$prompt += Write-Prompt $settings.DefaultPromptMiddle.Expand($ExecutionContext)

The Expand() method is sort of a fluent API that returns a copy of the original textspan but with the text expanded. Note: we have to pass in the $ExecutionContext or technically the $ExecutionContext.SessionState.InvokeCommand object but the former is less to type. :-) We have to do this because the context isn't available inside an instance of a PowerShell class.

I've tested the second approach above and it works fine.

I like the "extension method" approach the best.

Note: we have to pass in the $ExecutionContext…because the context isn't available inside an instance of a PowerShell class.

TIL

Cool. BTW poked around and found a way to get the $ExecutionContext inside the Expand() method so we won't have to pass that in after all. Turns out PS classes can't find this "automatic" variable when it is compiled but you can work-around it by asking for the variable at runtime with Get-Variable ExecutionContext -ValueOnly. So we should be able to simplify it to just:

$prompt += Write-Prompt $settings.DefaultPromptMiddle.Expand()

I've got a fix for both the DefaultPromptBeforeSuffix issue and Expand but with the branch updates on the server, I can no longer push my changes. Can we merge this then I'll submit another PR with those two changes? Or do you know the magic Git command to get my local branch in sync? I suppose I could delete it and check it out again from the server.

Assuming origin is your remote for this repo, and you have two new local commits since I rebased…

git fetch git rebase HEAD~2 --onto origin/rkeithhill/change-debugprompt

rkeithhill · 2018-04-18T15:30:37Z

Thanks for the rebase help. I "think" I've addressed all your PR concerns.

dahlbyk

LGTM. Please review the last two commits I added, then I think we're done.

Can you help me understand why sometimes you use [string](&$prompt 6>&1) and others you use this version?

Eh?

dahlbyk

Let's pretend I didn't just break the build.

Am I supposed to be using a specific version of Pester? I'm on a new machine that apparently came with Pester 3.4, but posh-git tests are failing. pester/Pester#585

dahlbyk

Am I supposed to be using a specific version of Pester? I'm on a new machine that apparently came with Pester 3.4, but posh-git tests are failing.

Answered my own question: -MinimumVersion 4.0.8

rkeithhill · 2018-04-19T02:05:48Z

src/posh-git.psm1

@@ -61,9 +61,7 @@ $GitPromptScriptBlock = {
    $prompt = ''

    # Write default prompt prefix if not empty.


Guess we should change the comment to just # Write default prompt prefix.

rkeithhill · 2018-04-19T02:06:14Z

src/posh-git.psm1

@@ -79,12 +77,10 @@ $GitPromptScriptBlock = {
    }

    # Write default prompt middle if not empty.


Ditto - drop the if not empty bit.

rkeithhill · 2018-04-19T02:10:13Z

src/GitPrompt.ps1

+            return $StringBuilder
+        }
+
+        return ""


Could probably simplify this to a one-liner: return $(if ($StringBuilder) {$StringBuilder} else {""})

That would be fine. I'm crashing for the night, but if you want to patch these up I can merge in the morning.

rkeithhill · 2018-04-19T02:31:50Z

RE:

Can you help me understand why sometimes you use [string](&$prompt 6>&1) and others you use this version?

Looks like I missed one in an ANSI test. In general, $res = [string](&$prompt *>&1) is used in all the NO ANSI cases so we get host information stream (all of them actually) redirected to stdout so we can capture the prompt string that was written using Write-Host. In the ANSI cases, there is only stdout output (string returned by the StringBuilder) so I simply use $res = &$prompt.

Want me to fix it?

dahlbyk · 2018-04-19T02:50:28Z

Want me to fix it?

I'm content for now as long as the tests are green. I do wonder about hiding some of the prompt-as-string complexity in a function so we don't have to touch all the tests if the patteen changes. Something to ponder.

Also modified ANSI tests to be consistent and not flatten $res with string interpolation. Catch more errors this way.

rkeithhill commented Feb 10, 2018

View reviewed changes

rkeithhill force-pushed the rkeithhill/change-debugprompt branch from c6fa372 to ec0318a Compare February 12, 2018 02:41

rkeithhill commented Feb 12, 2018

View reviewed changes

rkeithhill mentioned this pull request Feb 20, 2018

Roadmap to 1.0 #328

Open

13 tasks

rkeithhill force-pushed the rkeithhill/change-debugprompt branch 2 times, most recently from 9d4465c to 841eb45 Compare March 3, 2018 05:39

rkeithhill requested a review from dahlbyk March 10, 2018 22:44

rkeithhill added 5 commits April 16, 2018 22:02

Update to prompt func to allow path/status order swap

37f10ee

Add 32- or 64-bit to window title

cd2a85e

Tweak order of fields in $GitPromptSettings

9bd6556

Set abbrev home dir def to $true, magenta fg on dbg prompt

a53e408

Add sep between path/status and after both

5d70345

Add $global:PoshGitLastPrompt for ANSI escaped prompt str

dahlbyk force-pushed the rkeithhill/change-debugprompt branch from 841eb45 to 5d70345 Compare April 17, 2018 03:03

dahlbyk reviewed Apr 17, 2018

View reviewed changes

dahlbyk added this to the v1.0 milestone Apr 17, 2018

rkeithhill added 2 commits April 17, 2018 23:05

Merge branch 'develop' into rkeithhill/change-debugprompt

22baced

Change name of DefaultPromptMiddle and add Expand helper method

960ec64

dahlbyk approved these changes Apr 18, 2018

View reviewed changes

dahlbyk force-pushed the rkeithhill/change-debugprompt branch from 4df237a to 30a888e Compare April 18, 2018 18:51

dahlbyk approved these changes Apr 18, 2018

View reviewed changes

dahlbyk added 2 commits April 18, 2018 13:57

Short-circuit if nothing to do

0989d4e

Drop redundant empty checks

763368b

dahlbyk force-pushed the rkeithhill/change-debugprompt branch from 30a888e to 763368b Compare April 18, 2018 18:57

dahlbyk approved these changes Apr 18, 2018

View reviewed changes

rkeithhill commented Apr 19, 2018

View reviewed changes

rkeithhill and others added 2 commits April 18, 2018 21:08

Simply Write-Prompt early return, prompt func comments

68f569f

Also modified ANSI tests to be consistent and not flatten $res with string interpolation. Catch more errors this way.

Make Write-Prompt returns consistent

ddb0673

dahlbyk merged commit 554b881 into develop Apr 19, 2018

dahlbyk deleted the rkeithhill/change-debugprompt branch April 19, 2018 14:27

dahlbyk mentioned this pull request May 7, 2018

Update README.md for v1.0.0 release #572

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to prompt func to allow path/status order swap #544

Update to prompt func to allow path/status order swap #544

rkeithhill commented Feb 5, 2018

rkeithhill commented Feb 5, 2018

rkeithhill commented Feb 5, 2018

rkeithhill Feb 10, 2018 •

edited

Loading

rkeithhill Feb 10, 2018

rkeithhill Feb 12, 2018

rkeithhill commented Feb 16, 2018

rkeithhill commented Feb 18, 2018 •

edited

Loading

rkeithhill commented Feb 18, 2018 •

edited

Loading

rkeithhill commented Mar 24, 2018

dahlbyk left a comment

dahlbyk Apr 17, 2018

rkeithhill Apr 17, 2018

dahlbyk Apr 17, 2018

dahlbyk Apr 17, 2018

rkeithhill Apr 17, 2018 •

edited

Loading

dahlbyk Apr 17, 2018

rkeithhill Apr 17, 2018

dahlbyk Apr 17, 2018

rkeithhill Apr 17, 2018 •

edited

Loading

dahlbyk Apr 17, 2018

rkeithhill Apr 17, 2018

rkeithhill Apr 18, 2018 •

edited

Loading

dahlbyk Apr 18, 2018

rkeithhill commented Apr 18, 2018

dahlbyk left a comment

dahlbyk left a comment •

edited

Loading

dahlbyk left a comment

rkeithhill Apr 19, 2018

rkeithhill Apr 19, 2018

rkeithhill Apr 19, 2018

dahlbyk Apr 19, 2018

rkeithhill Apr 19, 2018

rkeithhill commented Apr 19, 2018 •

edited

Loading

dahlbyk commented Apr 19, 2018

		@@ -61,9 +61,7 @@ $GitPromptScriptBlock = {
		$prompt = ''

		# Write default prompt prefix if not empty.

		@@ -79,12 +77,10 @@ $GitPromptScriptBlock = {
		}

		# Write default prompt middle if not empty.

Update to prompt func to allow path/status order swap #544

Update to prompt func to allow path/status order swap #544

Conversation

rkeithhill commented Feb 5, 2018

rkeithhill commented Feb 5, 2018

rkeithhill commented Feb 5, 2018

rkeithhill Feb 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill commented Feb 16, 2018

rkeithhill commented Feb 18, 2018 • edited Loading

rkeithhill commented Feb 18, 2018 • edited Loading

rkeithhill commented Mar 24, 2018

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

rkeithhill Apr 17, 2018 • edited Loading

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

rkeithhill Apr 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill Apr 18, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill commented Apr 18, 2018

dahlbyk left a comment

Choose a reason for hiding this comment

dahlbyk left a comment • edited Loading

Choose a reason for hiding this comment

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

rkeithhill commented Apr 19, 2018 • edited Loading

dahlbyk commented Apr 19, 2018

rkeithhill Feb 10, 2018 •

edited

Loading

rkeithhill commented Feb 18, 2018 •

edited

Loading

rkeithhill commented Feb 18, 2018 •

edited

Loading

rkeithhill Apr 17, 2018 •

edited

Loading

rkeithhill Apr 17, 2018 •

edited

Loading

rkeithhill Apr 18, 2018 •

edited

Loading

dahlbyk left a comment •

edited

Loading

rkeithhill commented Apr 19, 2018 •

edited

Loading