Skip to content

A plugin to make using Prezto with antidote seamless

License

Notifications You must be signed in to change notification settings

getantidote/use-prezto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

use-prezto

A plugin to make using Prezto with antidote seamless

The Zsh plugin manager antidote can be used to load subplugins/submodules, such as those included in frameworks like Prezto and Oh-My-Zsh. However, it doesn't have specific logic to treat these popular Zsh frameworks different than any other plugin. With projects like Prezto that assume they aren't loaded any way other than the documented default, that can be a problem.

Since antidote is intended to be a general-purpose, high performance Zsh plugin manager without added complexity or special handling of frameworks like Prezto, this simple plugin serves as a bridge. It's not strictly necessary to use use-prezto with antidote, but it really helps, and is highly recommended.

How do I use it?

Simply include this plugin FIRST, at the top of your antidote ${ZDOTDIR:-$HOME}/.zsh_plugins.txt file. To do that, add this line:

getantidote/use-prezto

It's that easy. Now, you can use Prezto modules without worry.

Performance

Q: Is this fast?
A: Absolutely! With antidote, I'm committed to making sure Zsh users have a speedy shell. You can run benchmarks for yourself with zsh-bench.

Troubleshooting

Q: Do I need to use this plugin if I'm using antidote and Prezto?
A: Not strictly, but this plugin is now the officially supported way to use antidote correctly with Prezto.

Q: What if I find an Prezto module that doesn't work?
A: Submit an issue here. Prezto specific issues won't be fixed within antidote itself, but this project aims to support every Prezto module with antidote.

Examples

There is a sample ZDOTDIR project included with antidote which shows many examples.

Here's a more complete .zsh_plugins.txt you can use as a starter config.

#
# ${ZDOTDIR:-$HOME}/.zsh_plugins.txt
#

# If you use Prezto with antidote, load this plugin FIRST to set things up so you
# don't have to worry about whether Prezto will work correctly.
getantidote/use-prezto

# TODO...

# ... etc ...

Differences

A quick note on differences in behavior between Prezto and use-prezto:

  • TODO...

About

A plugin to make using Prezto with antidote seamless

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages