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

Hard project dependencies should roll out more gracefully #3

Open
theniceboy opened this issue Aug 30, 2021 · 6 comments
Open

Hard project dependencies should roll out more gracefully #3

theniceboy opened this issue Aug 30, 2021 · 6 comments

Comments

@theniceboy
Copy link

The commit 7386964 added prompt-pwd as a hard dependency. The problem was that users who ran zimfw update without installing prompt-pwd before hand would get an error (prompt-pwd command not found). This wouldn't be an ideal UX.

Just a suggestion. Great work btw!

@ericbn
Copy link
Member

ericbn commented Aug 30, 2021

Hi @theniceboy. Yeah, I'm aware it's not the nicest experience, but currently modules don't have a programmatically way of declaring their dependencies.

Our modules closely follow the Prezto standard for the modules structure, and Zim is also compatible with most of the Oh-My-Zsh standard, and none of these define a way of declaring dependencies. The best I've come up with is an 📢 Announcements channel where I publish all these changes...

@theniceboy
Copy link
Author

Thanks for your response, @ericbn!

I don't update my zim plugins usually (maybe once a few weeks). I happened to update them today and got the error. I ended up going a round trip trying to figure out what the problem was haha. Initially, I thought it could be a zsh version issue because I also upgraded zsh. I wonder if there's a way to notify users that prompt-pwd is actually a module that users need to install, just to save their time.

I wasn't aware of the Announcement channel... Frankly, I doubt people will notice.

@ericbn
Copy link
Member

ericbn commented Aug 30, 2021

Another way we have to make the users aware of the changes is showing the git log in zimfw update. So you should have seen something like:

) magicmace: Updating 9fc8e39..7386964
  * 7386964 Require prompt-pwd module (18 hours ago)

@Konfekt
Copy link

Konfekt commented Sep 7, 2021

How about showing after an update the git log once after starting up ZSH? Then a breaking change could be mentioned in the commit message.

@ericbn
Copy link
Member

ericbn commented Sep 7, 2021

I suggest users should subscribe to the 📢 Announcements channel instead.

@Konfekt
Copy link

Konfekt commented Sep 7, 2021

Thank you for putting together this overview of the latest changes to zimfw.

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

No branches or pull requests

3 participants