Add Git stash support #462

carhartl · 2019-02-11T11:35:12Z

This is adding support for git stashes. E.g. if there are any stashes show an icon, otherwise not (similar to how git arrows behave). Said icon is configurable via PURE_GIT_STASH_SYMBOL environment variable.

It's implemented utilizing vcs_info's misc message + hook for tracking information about stashes.

Please take this as a proposal I guess; while #365 is still open, I'm aware of the discussion in #317..

sindresorhus · 2019-02-18T05:39:56Z

If we decide to accept this, it should at minimum be opt-in using zstyle as outlined in (someone needs to implement that).

Alternatively, #460 could allow you do add this yourself without having to fork Pure.

sindresorhus · 2019-06-11T08:29:52Z

@mafredri Are you ok with adding this as opt-in through zstyle?

mafredri · 2019-09-23T06:31:29Z

@mafredri Are you ok with adding this as opt-in through zstyle?

I think that would be alright. So would we have an env variable for configuring the icon, and a zstyle for enabling the feature? Or should we take this opportunity to start defining icons in zstyle as well?

sindresorhus · 2019-09-23T07:58:13Z

Or should we take this opportunity to start defining icons in zstyle as well?

Yes

sindresorhus · 2019-11-29T10:08:48Z

@carhartl Can you make it use zstyle?

carhartl · 2019-11-29T11:38:18Z

@sindresorhus Need to learn more about that but happy to try...

carhartl · 2019-11-30T08:57:36Z

@sindresorhus So it‘s supposed to be implemented as @mafredri suggested:

zstyle for enabling the feature
zstyle for defining the icon

?

Using vcs_info's misc via hook to populate information about whether current directory has stashes...

carhartl · 2019-12-01T10:27:47Z

I think it would be better to migrate all of the icons to zstyle, not just the one for stashes. This seems out of scope of this PR and I'd like to do this in a follow-up PR.

sindresorhus · 2019-12-01T10:52:53Z

So it‘s supposed to be implemented as @mafredri suggested:
zstyle for enabling the feature
zstyle for defining the icon

👍

I think it would be better to migrate all of the icons to zstyle, not just the one for stashes. This seems out of scope of this PR and I'd like to do this in a follow-up PR.

👍

carhartl · 2019-12-01T12:08:48Z

@sindresorhus

Showing the stash status does now require opt-in via zstyle ":prompt:pure:git:stash:show" enable yes. The stash symbol color is also zstyle'd.

Is there anything else needed for this to be merged?

carhartl · 2019-12-01T13:41:09Z

Hmmm, might be nicer if we‘re not setting up the hook in the first place unless opted in!

mafredri · 2019-12-01T13:44:42Z

readme.md


+Showing git stash status as part of the prompt is not activated by default. To activate this you'll need to opt in via `zstyle`:
+
+`zstyle ':prompt:pure:git:stash:show' enable yes`


Show and enable sounds a bit repetitive to me. Could it make sense to drop :show here? Or drop show and rename enable => show.

mafredri · 2019-12-01T13:45:58Z

pure.zsh

+	# and stash information via misc (%m).
+	zstyle ':vcs_info:git*' formats '%b' '%R' '%a' '%m'
+	zstyle ':vcs_info:git*' actionformats '%b' '%R' '%a' '%m'
+	zstyle ':vcs_info:git*+set-message:*' hooks git-stash


Ideally I’d like us to avoid “doing the work” for gut stash, unless it’s enabled. But it’s not critical for this PR and we cam change it afterwards.

mafredri · 2019-12-01T13:50:55Z

pure.zsh

+	zstyle ':vcs_info:*' max-exports 4
+	# Export branch (%b), Git toplevel (%R), action (rebase/cherry-pick) (%a),
+	# and stash information via misc (%m).
+	zstyle ':vcs_info:git*' formats '%b' '%R' '%a' '%m'


I’m guessing there are no repercussions from including %a here?

For some reason it was producing an error when formats didn't have the same amount as actionformats. I really don't understand why these two seem to interact, maybe I did something wrong elsewhere, still new to zsh internals.

EDIT: not an error, but something that looked like an error, but was just not the expected output.

Alright, it’s been a while since I worked with vcs_info as well so just being cautious 😄. It’s probably fine.

Took a second look... %m was only required in formats only, but not in actionformats.

Interesting. How about when a git rebase is active? That’s when action formats kick in AFAICR.

Ah, the actionformats are for when git is performing a merge or rebase. If I understand all this correctly, if we were omitting %m from actionformats, info[stash]=$vcs_info_msg_3_ would remain empty (?) and the stash symbol would never be shown during such an action. Which is what we want?

I guess we need to ensure that $vcs_info_msg_3_ would always point to the expected output...

sindresorhus · 2019-12-01T13:53:31Z

Can we make it zstyle ':prompt:pure:git:stash' enable yes? (Without the show)

mafredri · 2019-12-01T13:54:07Z

Looks like we all had a few of the same ideas 😅

carhartl · 2019-12-01T15:03:48Z

Can we make it zstyle ':prompt:pure:git:stash' enable yes?

:prompt:pure:git:stash is used for the color already, to prevent that clash I thought I need to introduce the additional :show. So with @mafredri's suggestion, would

zstyle ':prompt:pure:git:stash:show' show yes

be ok? Or maybe zstyle ':prompt:pure:git' stash yes is more in line with the intended usage of zstyle?

mafredri · 2019-12-01T15:36:13Z

:prompt:pure:git:stash is used for the color already, to prevent that clash I thought I need to introduce the additional :show. So with @mafredri's suggestion, would

That’s ok because there can be multiple values under a zstyle. So :prompt:pure:git:stash should be able to store both color=x and show=y.

be ok? Or maybe zstyle ':prompt:pure:git' stash yes is more in line with the intended usage of zstyle?

This could also work. For me the former feels a bit more uniform but this is essentially a matter of enabling / disabling showing of git features so ¯\_(ツ)_/¯. I’m fine with either.

carhartl · 2019-12-01T15:40:40Z

Ah, please bear with me... I missed to think of :prompt:pure:git:stash as some sort of namespace. Thanks for clarifying.

This changes everything :)

Then I also think we should go for :prompt:pure:git:stash, will allow to configure related things in the same way, as pointed out.

zstyle ':prompt:pure:git:stash' show yes
zstyle ':prompt:pure:git:stash' color yellow
zstyle ':prompt:pure:git:stash' icon S

Updating the commit...

pure.zsh

carhartl · 2019-12-07T09:51:45Z

Is there anything you need me to add?

fladson · 2020-01-07T15:15:51Z

I would love to see this merged, thanks for adding it.

sindresorhus · 2020-02-08T20:48:28Z

readme.md

@@ -70,7 +70,11 @@ prompt pure
 | **`PURE_PROMPT_VICMD_SYMBOL`**   | Defines the prompt symbol used when the `vicmd` keymap is active (VI-mode).                    | `❮`            |
 | **`PURE_GIT_DOWN_ARROW`**        | Defines the git down arrow symbol.                                                             | `⇣`            |
 | **`PURE_GIT_UP_ARROW`**          | Defines the git up arrow symbol.                                                               | `⇡`            |
+| **`PURE_GIT_STASH_SYMBOL`**      | Defines the git stash symbol.                                                                  | `≡`            |


As discussed in the comments, this should be zstyle ':prompt:pure:git:stash' icon S.

sindresorhus · 2020-02-08T20:48:59Z

@carhartl Sorry, this fell off my radar. There are some remaining feedback:

carhartl · 2020-02-08T22:04:49Z

@sindresorhus

Oh, ok. Regarding the icon configuration I thought you agreed that this would be out of scope and would better be done for all icons instead of just this new one in a separate PR.

See #462 (comment)

sindresorhus · 2020-02-08T22:09:34Z

Forgot about my comment. Never mind the zconfig thing then.

carhartl · 2020-02-08T22:14:08Z

Regarding the other issue: I had already changed it to

zstyle ':prompt:pure:git:stash' show yes

but it looks like I overlooked to adapt that in one place in the readme.

carhartl · 2020-02-09T10:25:43Z

@sindresorhus I have fixed the issue in the readme...

sindresorhus · 2020-02-14T08:22:56Z

Looks good. Thanks for working on this 🙌

carhartl added 4 commits December 1, 2019 10:46

Implement support for git stash

0019ee5

Using vcs_info's misc via hook to populate information about whether current directory has stashes...

Simplify counting stashes

815fb41

Make git stash symbol configurable

917ec33

Adapt readme to include git stash symbol

e9df830

carhartl force-pushed the git-stash-support branch from f372b09 to e9df830 Compare December 1, 2019 10:06

Apply stash symbol color using zstyle

2e45abe

mafredri reviewed Dec 1, 2019

View reviewed changes

carhartl force-pushed the git-stash-support branch from 0a0f3d0 to 3fb7fe0 Compare December 1, 2019 15:51

mafredri reviewed Dec 1, 2019

View reviewed changes

pure.zsh Outdated Show resolved Hide resolved

sindresorhus changed the title ~~Git stash support~~ Add Git stash support Dec 6, 2019

ntwb mentioned this pull request Jan 30, 2020

Added flag when stash > 0 pure-fish/pure#53

Closed

sindresorhus reviewed Feb 8, 2020

View reviewed changes

carhartl added 3 commits February 9, 2020 11:24

Adapt stash status to require opt-in via zstyle

c2d72a8

Account for function being invoked asynchronously

5397f7b

Fix some typos

d5f3c7d

carhartl force-pushed the git-stash-support branch from f8f5a0d to d5f3c7d Compare February 9, 2020 10:24

sindresorhus merged commit 70498a0 into sindresorhus:master Feb 14, 2020

sindresorhus mentioned this pull request Feb 14, 2020

git stash #365

Closed

carhartl deleted the git-stash-support branch February 14, 2020 10:17

camsteffen mentioned this pull request Feb 17, 2020

Bug: Git stash shows during git action #532

Closed

carhartl mentioned this pull request Feb 20, 2020

Fix stash symbol showing during git actions #533

Closed

kutsan pushed a commit to kutsan/pure that referenced this pull request Jun 19, 2023

Add Git stash support (sindresorhus#462)

2b6e7af

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Git stash support #462

Add Git stash support #462

carhartl commented Feb 11, 2019

sindresorhus commented Feb 18, 2019

sindresorhus commented Jun 11, 2019

mafredri commented Sep 23, 2019

sindresorhus commented Sep 23, 2019

sindresorhus commented Nov 29, 2019

carhartl commented Nov 29, 2019

carhartl commented Nov 30, 2019

carhartl commented Dec 1, 2019

sindresorhus commented Dec 1, 2019

carhartl commented Dec 1, 2019

carhartl commented Dec 1, 2019

mafredri Dec 1, 2019

mafredri Dec 1, 2019

mafredri Dec 1, 2019

carhartl Dec 1, 2019 •

edited

Loading

mafredri Dec 1, 2019

carhartl Dec 1, 2019

mafredri Dec 1, 2019

carhartl Dec 1, 2019 •

edited

Loading

carhartl Dec 1, 2019

sindresorhus commented Dec 1, 2019

mafredri commented Dec 1, 2019

carhartl commented Dec 1, 2019

mafredri commented Dec 1, 2019

carhartl commented Dec 1, 2019

carhartl commented Dec 7, 2019

fladson commented Jan 7, 2020

sindresorhus Feb 8, 2020

sindresorhus commented Feb 8, 2020

carhartl commented Feb 8, 2020

sindresorhus commented Feb 8, 2020

carhartl commented Feb 8, 2020 •

edited

Loading

carhartl commented Feb 9, 2020

sindresorhus commented Feb 14, 2020


		Showing git stash status as part of the prompt is not activated by default. To activate this you'll need to opt in via `zstyle`:

		`zstyle ':prompt:pure:git:stash:show' enable yes`

Add Git stash support #462

Add Git stash support #462

Conversation

carhartl commented Feb 11, 2019

sindresorhus commented Feb 18, 2019

sindresorhus commented Jun 11, 2019

mafredri commented Sep 23, 2019

sindresorhus commented Sep 23, 2019

sindresorhus commented Nov 29, 2019

carhartl commented Nov 29, 2019

carhartl commented Nov 30, 2019

carhartl commented Dec 1, 2019

sindresorhus commented Dec 1, 2019

carhartl commented Dec 1, 2019

carhartl commented Dec 1, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carhartl Dec 1, 2019 • 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

carhartl Dec 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Dec 1, 2019

mafredri commented Dec 1, 2019

carhartl commented Dec 1, 2019

mafredri commented Dec 1, 2019

carhartl commented Dec 1, 2019

carhartl commented Dec 7, 2019

fladson commented Jan 7, 2020

Choose a reason for hiding this comment

sindresorhus commented Feb 8, 2020

carhartl commented Feb 8, 2020

sindresorhus commented Feb 8, 2020

carhartl commented Feb 8, 2020 • edited Loading

carhartl commented Feb 9, 2020

sindresorhus commented Feb 14, 2020

carhartl Dec 1, 2019 •

edited

Loading

carhartl Dec 1, 2019 •

edited

Loading

carhartl commented Feb 8, 2020 •

edited

Loading