From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: Marlon <marlon.richert@gmail.com>
Cc: Zsh hackers list <zsh-workers@zsh.org>
Subject: Re: [RFC][PATCH] `newuser` prompt theme
Date: Wed, 14 Apr 2021 14:09:09 +0000 [thread overview]
Message-ID: <20210414140909.GG3882@tarpaulin.shahaf.local2> (raw)
In-Reply-To: <6CEA4F3E-9A64-44E1-9121-FA9D5E053AB5@gmail.com>
Marlon wrote on Wed, Apr 14, 2021 at 16:17:02 +0300:
> On 14 Apr 2021, at 15:05, Daniel Shahaf <d.s@daniel.shahaf.name> wrote:
> >
> >> new file mode 100644
> >> +++ b/Functions/Prompts/prompt_newuser_setup
> >
> > At the risk of bikeshedding, I don't think that's a good name. A name
> > should describe what a thing *is*, not what its intended use is; and I'm
> > not particularly fond of the implication that new users should be wary
> > of trying _other_ themes. Besides, what if someone else were to come
> > along and post an alternative theme aimed at new users?
>
> Sure, but what should I call it, then? Just `marlon`? (Seeing as we already have `adam`, `bart`, etc. themes.)
That'd work. A name that describes the theme itself rather than its
origin would be even better (if the theme is accepted into zsh.git).
> >> + ;|
> >> + <1-> )
> >> + psvar[1]+="($exitstatus)"
> >> + esac
> >> +
> >> + if ! [[ -v vcs_info_msg_0_ ]]; then
> >> + zstyle ':vcs_info:*' check-for-staged-changes yes
> >
> > First, no other prompt theme sets styles, so I'm not sure prompt themes
> > should be doing that.
>
> Please show me another way to theme the VCS part of the prompt and I will use that.
You seem to have checked your manners in at the door.
In any case, what you've implemented is that you re-set a style on the
first precmd after every chdir. I don't think these semantics should be
implemented in the first place.
> > Second, even if a prompt were to set styles, doing so in a precmd and
> > behind what _looks_ like a "first run" condition but is actually a "we
> > just changed directory" condition isn't exactly best practice.
>
> What would be a better practice?
Don't surprise/mislead code readers.
Don't surprise/mislead users.
Document your code.
Make defaults overridable.
Don't trample user settings (e.g., someone explicitly setting that style
to a false value for that same context, or for the context «:vcs_info*»,
which is less specific than the context you use and thus would be shadowed).
These are all such ground rules that I'm surprised I have to spell them out.
> >> +prompt_newuser_setup() {
> >> + prompt_opts=( cr percent sp )
> >> +
> >> + zstyle -e ':vcs_info:*' formats '
> >> + reply=( "%u%c$( prompt_newuser_format start branch repo )" )
> >> + '
> >> + zstyle -e ':vcs_info:*' actionformats '
> >> + reply=( "%u%c$( prompt_newuser_format start action repo )" )
> >> + '
> >> + zstyle -e ':vcs_info:*' stagedstr '
> >> + reply=( "$( prompt_newuser_format start staged )" )
> >> + '
> >> + zstyle -e ':vcs_info:*' unstagedstr '
> >> + reply=( "$( prompt_newuser_format start unstaged )" )
> >> + '
> >
> > Your theme does _nothing_ with the 'unstaged' style other than
> > pass it through verbatim.
>
> After setting it to '%B%F{red}*%b%f’, yes.
>
Hmm. That's a good question: how _should_ a theme set an overrideable
default for stagedstr?
>
> > That appears to be NIH.
>
> Sorry, but what does NIH stand for? (I’m guessing you don’t mean the National Institutes of Health.)
>
Not Invented Here syndrome; cf. EEE :P
> > Why shouldn't the theme just advise people to set the vcs_info
> > directly?
>
> Because it’s a theme? If people wanted to style their vcs_info
> directly, then why would they use a theme?
The point is, you're making people learn a different syntax for
identical functionality for zero benefit.
> Conversely, VCS info is the number one thing that new users want to
> add to their prompt. I don’t think it’s unreasonable to expect that to
> be included out of the box. Nearly all of 3rd-party prompt themes in
> the wild include at least Git info.
The question remains whether or not for a prompt theme to set vcs_info
styles does or doesn't violate the principle of least surprise.
> > The promptinit changes are independent of the new theme. They should be
> > a separate patch and could conceivably be applied separately.
>
> Sure, I’ll start a separate patch thread for those.
Thanks.
>
Daniel
next prev parent reply other threads:[~2021-04-14 14:09 UTC|newest]
Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-13 19:41 Marlon
2021-04-13 20:31 ` Roman Perepelitsa
2021-04-13 20:44 ` Bart Schaefer
2021-04-14 5:09 ` Marlon Richert
2021-04-14 5:17 ` Bart Schaefer
2021-04-14 5:45 ` Marlon
2021-04-14 12:05 ` Daniel Shahaf
2021-04-14 13:17 ` Marlon
2021-04-14 14:09 ` Daniel Shahaf [this message]
2021-04-15 1:07 ` Bart Schaefer
2021-04-15 3:50 ` Marlon Richert
2021-04-15 20:27 ` Daniel Shahaf
2021-04-15 23:42 ` Daniel Shahaf
2021-04-15 11:11 ` Mikael Magnusson
2021-04-15 16:44 ` vcs_info's global variables (was: Re: [RFC][PATCH] `newuser` prompt theme) Daniel Shahaf
2021-04-16 16:04 ` [RFC][PATCH] `newuser` prompt theme Marlon
2021-04-16 17:13 ` Daniel Shahaf
2021-04-16 19:19 ` Marlon Richert
2021-04-16 19:30 ` Daniel Shahaf
2021-04-19 16:46 ` Marlon Richert
2021-05-02 17:18 ` Lawrence Velázquez
2021-05-03 2:38 ` Bart Schaefer
2021-05-03 4:11 ` Lawrence Velázquez
2021-05-03 11:38 ` [PATCH] Add customizable `vcs` prompt theme (was Re: [RFC][PATCH] `newuser` prompt theme) Marlon Richert
2021-05-09 18:04 ` Lawrence Velázquez
2021-05-31 1:01 ` Lawrence Velázquez
2021-06-09 12:58 ` Marlon Richert
2021-06-09 13:22 ` Roman Perepelitsa
2021-06-09 18:06 ` Marlon Richert
2021-06-10 9:30 ` Roman Perepelitsa
2021-06-10 13:47 ` Marlon Richert
2021-06-10 14:01 ` Marlon Richert
2021-06-10 17:45 ` Roman Perepelitsa
2021-06-20 22:13 ` Marlon Richert
2021-06-23 17:26 ` Roman Perepelitsa
2022-08-08 10:12 ` Marlon Richert
2022-08-08 10:17 ` Roman Perepelitsa
2021-04-14 14:09 ` sysexits.h codes? (was: " Daniel Shahaf
2021-04-30 19:40 ` Marlon Richert
2021-04-30 21:16 ` Daniel Shahaf
2021-04-30 21:34 ` Bart Schaefer
2021-05-01 15:09 ` Daniel Shahaf
2021-04-30 21:40 ` Bart Schaefer
2021-05-01 13:39 ` Marlon Richert
2021-05-01 14:43 ` Daniel Shahaf
2021-05-03 11:36 ` Marlon Richert
2021-05-03 16:04 ` Daniel Shahaf
2021-05-04 11:13 ` Marlon Richert
2021-05-21 11:38 ` Marlon Richert
2021-04-14 15:30 ` [RFC][PATCH] `newuser` prompt theme Arseny Maslennikov
2021-04-14 18:52 ` Daniel Shahaf
2021-04-14 14:00 ` precmd hooks and $? Bart Schaefer
2021-04-14 15:18 ` docs patches for precmd hooks and $?, and vcs_info Daniel Shahaf
2021-04-15 2:35 ` Bart Schaefer
2021-04-15 16:17 ` Archives render attachments as first-class messages (was: docs patches for precmd hooks and $?, and vcs_info) Daniel Shahaf
2021-04-15 18:54 ` [RFC][PATCH] Reset ZLE hooks when changing prompt themes (was Re: [RFC][PATCH] `newuser` prompt theme) Marlon
2021-04-15 21:34 ` Daniel Shahaf
2021-04-16 22:34 ` Marlon Richert
2021-04-25 16:08 ` Lawrence Velázquez
2021-05-02 17:03 ` Lawrence Velázquez
2021-05-02 17:59 ` Bart Schaefer
2021-05-05 6:10 ` Marlon Richert
2021-05-16 15:27 ` Lawrence Velázquez
2021-05-16 19:31 ` Marlon Richert
2021-05-17 4:19 ` Bart Schaefer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210414140909.GG3882@tarpaulin.shahaf.local2 \
--to=d.s@daniel.shahaf.name \
--cc=marlon.richert@gmail.com \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).