feat(zsh): update widget names #1631
Conversation
|
I'm happy with the change, but would it be possible to have aliases to the existing names? If we rename them without warning, some setups will break. One release is enough warning imo, we can remove the aliases after that |
Maybe I missed something, but I already left the old names (as described also in the commit message), so the existing setups shouldn't break. Or does it need to be a real Or should I also leave the new ones
I didn't intend to remove it soon, but if you'd like the warning message, I can add the warning message. |
The current widget names for Zsh start with "_", which gives an impression to users that those widgets are internal API and should not be bound by the users. However, we actually instruct users to set up custom keybindings by specifying them to bindkey. In other shells, a separate namespace for widgets are not prepared, so we want to prefix "_" to shell function names to tell the users that these are not the commands that are supposed to be called from the command line. However, the widget names are separated in their own namespace in Zsh, so we do not have to isolate them by prefixing "_". In fact, other frameworks such as `fzf` define widgets with names not starting with "_". In this patch, we update the widget names to have the form "atuin-*". The old widget names that existed in the release version <= 17.2.1 are left for compatibility.
akinomyoga
force-pushed
the
zsh-widget-name
branch
from
55ba79c
to
a6abbd5
Compare
|
I cleaned up slashes in docs that escaped |
No you're right, it's I that misread it! Thank you 🙏 |
|
Thanks!
Sure! I'm not able to create it now, but I'll later submit it (probably after a few or several hours). |
…search" This reflects the change in atuinsh/atuin#1631
|
Commit b8c6b9a corresponds to the widget name change introduced in atuinsh/atuin#1631. Also, the current documentation diverges from the current implementation. I updated the widgets for the <kbd>up</kbd> key in commit 6e1f3df. Also, the descriptions for the newly added widgets for `keymap_mode` (atuinsh/atuin#1570) are added in commit 705214a. Since the version dependence of documentation can confuse people as in atuinsh/atuin#1625, I decided to add a note on the version dependence and also a required version for each feature. I personally think it is useful to maintain in the documentation the minimal version requirement for each feature, but this might be the perspective of a developer who needs to consider the compatibility of products with arbitrary versions of other products. If you have a different preference, please tell me that. There is an extra commit 33a1d6d. Sorry, this is unrelated to the widget name but a tiny clarification of a description I added in my previous PR #10. If I should submit a change in a separate PR, please tell me that. It's a small change, but I'll create a separate one if you'd prefer it.
This is another suggestion. See the commit message.
For more contexts, the following is the list of how the other zsh frameworks name their widgets:
zvm_*vi-visual-*fzf-*-widgetplugins/{fuck,history-substring-search,man,per-directory-history,sudo,shrink-path}...<PLUGIN>-*(where<PLUGIN>is the name of the plugin)plugins/{npm,percol}...<PLUGIN>_*plugins/git-escape-magic...<PLUGIN>.*plugins/{globalias,copybuffer,fancy-ctrl-z}...<PLUGIN>(These define a single widget that has the same name as the plugin)plugins/zsh-navigation-tools...znt-*-widgetplugins/zsh-interactive-cd...zic-*plugins/jump..._mark_expansionplugins/dircycle...insert-cycled*plugins/safe-paste..._bracketed_paste_*plugins/dirhistory...dirhistory_zle_dirhistory_*Also, it should be noted that ZLE also prepares the special widget names
zle-*for the users to customize the behavior. The most popular namespacing seems to be<ProjectName>-*.