Merge pull request #232 from mattmc3/v1.9.11

v1.9.11

Author: mattmc3

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.9.10
+current_version = 1.9.11
 parse = v?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<revision>\d+)
 serialize = {major}.{minor}.{revision}
 

.gitignore

@@ -10,3 +10,4 @@ sandbox/
 *.old
 **/realzdotdir/zsh_plugins.zsh
 foo*.*
+!footer.*

README.md

@@ -1,7 +1,7 @@
 # antidote
 
 [![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg)](/LICENSE)
-![version](https://img.shields.io/badge/version-v1.9.10-df5e88)
+![version](https://img.shields.io/badge/version-v1.9.11-df5e88)
 
 <a title="GetAntidote"
    href="https://antidote.sh"

functions/__antidote_version

@@ -4,7 +4,7 @@
 #function __antidote_version {
   emulate -L zsh; setopt local_options $_adote_funcopts
   0=${(%):-%x}
-  local ver='1.9.10'
+  local ver='1.9.11'
   local gitsha=$(git -C "${0:A:h:h}" rev-parse --short HEAD 2>/dev/null)
   [[ -z "$gitsha" ]] || ver="$ver ($gitsha)"
   print "antidote version $ver"

man/antidote-bundle.adoc

@@ -0,0 +1,110 @@
+= antidote-bundle(1)
+:doctype: manpage
+:manmanual: Antidote Manual
+:mansource: antidote
+
+== Name
+antidote-bundle - download a bundle and print its source line
+
+== Synopsis
+*antidote bundle* [<bundles>...]
+
+== Description
+*antidote-bundle* assembles your Zsh plugins. Bundles can be git repos, or local files or directories. If a plugin is a repo, it will be cloned if necessary. The zsh code necessary to load (source) the plugin is then printed.
+
+----
+antidote bundle gituser/gitrepo
+antidote bundle $ZSH_CUSTOM/plugins/myplugin
+antidote bundle ${ZDOTDIR:-$HOME}/.zlibs/myfile.zsh
+----
+
+Bundles also support annotations. Annotations allow you have finer grained control over your plugins. Annotations are used in the form `keyword:value`.
+
+`kind`::
+  * *zsh*: A zsh plugin. This is the default kind of bundle.
+  * *fpath*: Only add the plugin to your `$fpath`.
+  * *path*: Add the plugin to your `$PATH`.
+  * *clone*: Only clone a plugin, but don't do anything else with it.
+  * *defer*: Defers loading of a plugin using `romkatv/zsh-defer`.
+  * *autoload*: Autoload all the files in the plugin directory as zsh functions.
+`branch`::
+  The branch annotation allows you to change the default branch of a plugin's repo from *main* to a branch of your choosing.
+`path`::
+  The path annotation allows you to use a subdirectory or file within a plugin's structure instead of the root plugin (eg: `path:plugins/subplugin`).
+`conditional`::
+  The conditional annotation allows you to wrap an *if* statement around a plugin's load script. Supply the name of a zero argument zsh function to conditional to perform the test (eg: `conditional:is-macos`).
+`pre` / `post`::
+  The pre and post annotations allow you to call a function before or after a plugin's load script. This is helpful when configuring plugins, since the configuration functions will only run for active plugins. Supply the name of a zero argument zsh function to pre or post.
+`autoload`::
+  The autoload annotation allows you to autoload a zsh functions directory in addition to however the plugin was loaded as specified by `kind`. Supply a relative path to autoload (eg: `autoload:functions`).
+
+Cloned repo directory names can be overridden with the following `zstyle`:
+
+----
+zstyle ':antidote:bundle' use-friendly-names 'yes'
+----
+
+== Options
+*-h, --help*:: Show the help documentation.
+*<bundles>...*:: Zsh plugin bundles.
+
+== Examples
+
+Using the *kind:* annotation:
+
+----
+# a regular plugin (kind:zsh is implied, so it's unnecessary)
+antidote bundle zsh-users/zsh-history-substring-search kind:zsh
+----
+
+----
+# add prompt plugins to $fpath
+antidote bundle sindresorhus/pure kind:fpath
+----
+
+----
+# add utility plugins to $PATH
+antidote bundle romkatv/zsh-bench kind:path
+----
+
+----
+# clone a repo for use in other ways
+antidote bundle mbadolato/iTerm2-Color-Schemes kind:clone
+----
+
+----
+# autoload a functions directory
+antidote bundle sorin-ionescu/prezto path:modules/utility/functions kind:autoload
+----
+
+----
+# defer a plugin to speed up load times
+antidote bundle olets/zsh-abbr kind:defer
+----
+
+Using the *branch:* annotation:
+
+----
+# don't use the main branch, use develop instead
+antidote bundle zsh-users/zsh-autosuggestions branch:develop
+----
+
+Using the *path:* annotation:
+
+----
+# load oh-my-zsh
+antidote bundle ohmyzsh/ohmyzsh path:lib
+antidote bundle ohmyzsh/ohmyzsh path:plugins/git
+----
+
+Using the *conditional:* annotation:
+
+----
+# define a conditional function prior to loading antidote
+function is_macos {
+  [[ $OSTYPE == darwin* ]] || return 1
+}
+
+# conditionally load a plugin using the function you made
+antidote bundle ohmyzsh/ohmyzsh path:plugins/macos conditional:is_macos
+----

man/antidote-bundle.md

@@ -0,0 +1,17 @@
+= antidote-help(1)
+:doctype: manpage
+:manmanual: Antidote Manual
+:mansource: antidote
+
+== Name
+antidote-help - show antidote documentation
+
+== Synopsis
+*antidote help* [<command>]
+
+== Description
+*antidote-help* is used to show context-sensitive help for antidote and its commands.
+
+== Options
+*-h, --help*:: Inception-style meta-help recursively.
+*<command>*:: Show help for a specific command.

man/antidote-help.adoc

@@ -0,0 +1,29 @@
+= antidote-home(1)
+:doctype: manpage
+:manmanual: Antidote Manual
+:mansource: antidote
+
+== Name
+antidote-home - print where antidote is cloning bundles
+
+== Synopsis
+*antidote home*
+
+== Description
+*antidote-home* shows you where antidote stores its cloned repos. It is not the home of the antidote utility itself.
+
+----
+antidote home
+----
+
+You can override antidote's default home directory by setting the `$ANTIDOTE_HOME` variable in your `.zshrc`.
+
+== Options
+*-h, --help*:: Show the help documentation.
+
+== Examples
+You can clear out all your cloned repos like so:
+
+----
+rm -rfi "$(antidote home)"
+----