Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 2.24 KB

Writing_Plugins.md

File metadata and controls

19 lines (10 loc) · 2.24 KB
Raw

Writing Plugins

Try and keep your plugins as cross-framework compatible as possible. Here are some suggestions to make installing and using your plugin as simple as possible, no matter what framework someone is using.

  1. Make using it easier for everyone and put the plugin file at the root level of your plugin repository instead of in a subdirectory. This allows oh-my-zsh users to install it with a simple git clone [email protected]:you/yourplugin.git in the custom/plugins directory and also lets Antigen and zgen users automatically clone the repository without having to specify a subdirectory path.

  2. Only oh-my-zsh sets the ${ZSH_CUSTOM} variable. Relying on your plugin being in ${ZSH_CUSTOM}/yourPluginName will make your plugin not work with anything but oh-my-zsh. $(dirname $0) will tell you what directory your plugin is actually installed in and has the advantage of both being cross-framework and not breaking when a user inevitably renames your plugin directory.

  3. Don't assume your plugin will be checked out into a directory with the same name you gave the plugin. This is another case where $(dirname ${0}) will work and ${ZSH_CUSTOM}/hardcoded-directory will fail.

  4. Use yourplugin.plugin.zsh for the main plugin file. This is what oh-my-zsh looks for. Antigen, zgen and most other ZSH frameworks will also automatically load that filename.

  5. If you’re making a theme, please include a screenshot so prospective users can see what it looks like without having to install it.

  6. If your plugin adds any of its subdirectories to the fpath, make sure those subdirectories only contain function definition files. This allows for frameworks to correctly zcompile all functions. Don't make your plugin add its root directory to the fpath.

  7. Don't forget to add a license. choosealicense.com is a good tool to help you pick one.

  8. Submit a PR here so your plugin is easy to find :-)