Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

oh-my-zsh is not the only ZSH framework that uses plugin.zsh files #48

Closed
unixorn opened this issue Dec 15, 2015 · 10 comments
Closed

oh-my-zsh is not the only ZSH framework that uses plugin.zsh files #48

unixorn opened this issue Dec 15, 2015 · 10 comments

Comments

@unixorn
Copy link

unixorn commented Dec 15, 2015

Many other ZSH frameworks like zgen and Antigen use .plugin.zsh files for compatibility with oh-my-zsh.

2f8a5f8 removes functionality for some non-oh-my-zsh-frameworks.

@sunaku
Copy link
Member

sunaku commented Dec 15, 2015

Couldn't we update those other frameworks to reinstate whatever subset of the removed configuration they use on their end? Because those $CASE_SENSITIVE and $DISABLE_COLOR flags aren't part of ZSH itself.

@sunaku
Copy link
Member

sunaku commented Jul 16, 2016

❗ Ping @unixorn. Is this still an issue? Have those frameworks reconfigured this plugin since? Thanks.

@Tarrasch
Copy link
Contributor

@sunaku You can easily fix this issue by having a commit like this one: Tarrasch@f20ed56, I already did it in sindresorhus/pure#75 and it was appreciated there. :)

@unixorn
Copy link
Author

unixorn commented Aug 29, 2016

@sunaku - Sorry, I managed to miss your previous comment. The other frameworks don't have code specific to this plugin, it is that their generic plugin handling code assumes they'll find something.plugin.zsh in a repo checkout since that is the standard used in oh-my-zsh.

@sunaku
Copy link
Member

sunaku commented Oct 19, 2016

Per @desyncr's answer in #59 (comment), this extra *.plugin.zsh file is unnecessary; closing. 😅

@sunaku sunaku closed this as completed Oct 19, 2016
@Tarrasch
Copy link
Contributor

@sunaku, *.plugin.zsh is a convention. Antigen is one out of many plugin managers and it's deliberately not strict on enforcing conventions. Many other plugin managers exist and even antigen docs suggests you to put the *.plugin.zsh file there.

All this said. I have strong opinions about this and in fact I have even made my own fairly popular plugin manager. :)

@sunaku
Copy link
Member

sunaku commented Oct 20, 2016

I'm against providing a conventional *.plugin.zsh configuration file for this plugin because that would make the out-of-the-box experience different only for users of ZSH plugin managers. ☔ It would also require that we support two kinds of users: those who use ZSH plugin managers and those who do not. 💕

Instead, I want users to look through the README and then define the keybindings and configure the documented variables to suit their own personal needs. 📖 It's a one-time thing: Just set it and forget it! 🎐

@Tarrasch
Copy link
Contributor

I'm not sure what you mean with different out-of-the-box experiences. See my post above. That you both use a plugin manager and read the README/do configuring is nothing unique to this plugin.

@sunaku
Copy link
Member

sunaku commented Oct 20, 2016

Restoring *.plugin.zsh from 2f8a5f8, as requested by @unixorn in this issue's description above, would provide a different out-of-the-box experience for users of ZSH plugin managers versus other users.

However, I now understand that you're asking for something else: you want to provide a *.plugin.zsh symlink. Regarding this, @desyncr has answered in #59 (comment) that Antigen doesn't necessarily need a *.plugin.zsh file because it eagerly loads any *.zsh files. 🍰 Therefore, providing a *.plugin.zsh symlink is unnecessary for Antigen users (because they'll get the same experience whether or not that symlink is actually provided), which is what I thought I communicated in #48 (comment) when I closed this issue. 👮‍♂️

@Tarrasch
Copy link
Contributor

Well, at least I feel confident that you understand what I mean now. I personally would stick to follow conventions to comply to as many plugin managers as possible. But I suppose you don't want the extra clutter of a symlink and stuff. Thanks for talking this through! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants