mj / zsh-config

Download as
Browse Code ยป

Commit 2b0796f6a5b1998216aa5740f273693f6af35479

Authored by Shrikant Sharat
1 parent da678afb28

Add a `Usage:` line to `-use` command's err output.

Showing 1 changed file with 4 additions and 3 deletions Inline Diff

1 #!/bin/zsh 1 #!/bin/zsh
2 2
3 # Each line in this string has the following entries separated by a space 3 # Each line in this string has the following entries separated by a space
4 # character. 4 # character.
5 # <repo-url>, <plugin-location>, <bundle-type>, <has-local-clone> 5 # <repo-url>, <plugin-location>, <bundle-type>, <has-local-clone>
6 # FIXME: Is not kept local by zsh! 6 # FIXME: Is not kept local by zsh!
7 local _ANTIGEN_BUNDLE_RECORD="" 7 local _ANTIGEN_BUNDLE_RECORD=""
8 local _ANTIGEN_INSTALL_DIR="$(cd "$(dirname "$0")" && pwd)" 8 local _ANTIGEN_INSTALL_DIR="$(cd "$(dirname "$0")" && pwd)"
9 9
10 # Used to defer compinit/compdef 10 # Used to defer compinit/compdef
11 typeset -a __deferred_compdefs 11 typeset -a __deferred_compdefs
12 compdef () { __deferred_compdefs=($__deferred_compdefs "$*") } 12 compdef () { __deferred_compdefs=($__deferred_compdefs "$*") }
13 13
14 # Syntaxes 14 # Syntaxes
15 # antigen-bundle <url> [<loc>=/] 15 # antigen-bundle <url> [<loc>=/]
16 # Keyword only arguments: 16 # Keyword only arguments:
17 # branch - The branch of the repo to use for this bundle. 17 # branch - The branch of the repo to use for this bundle.
18 antigen-bundle () { 18 antigen-bundle () {
19 19
20 # Bundle spec arguments' default values. 20 # Bundle spec arguments' default values.
21 local url="$ANTIGEN_DEFAULT_REPO_URL" 21 local url="$ANTIGEN_DEFAULT_REPO_URL"
22 local loc=/ 22 local loc=/
23 local branch= 23 local branch=
24 local no_local_clone=false 24 local no_local_clone=false
25 local btype=plugin 25 local btype=plugin
26 26
27 # Parse the given arguments. (Will overwrite the above values). 27 # Parse the given arguments. (Will overwrite the above values).
28 eval "$(-antigen-parse-args \ 28 eval "$(-antigen-parse-args \
29 'url?, loc? ; branch:?, no-local-clone?, btype:?' \ 29 'url?, loc? ; branch:?, no-local-clone?, btype:?' \
30 "$@")" 30 "$@")"
31 31
32 # Check if url is just the plugin name. Super short syntax. 32 # Check if url is just the plugin name. Super short syntax.
33 if [[ "$url" != */* ]]; then 33 if [[ "$url" != */* ]]; then
34 loc="plugins/$url" 34 loc="plugins/$url"
35 url="$ANTIGEN_DEFAULT_REPO_URL" 35 url="$ANTIGEN_DEFAULT_REPO_URL"
36 fi 36 fi
37 37
38 # Resolve the url. 38 # Resolve the url.
39 url="$(-antigen-resolve-bundle-url "$url")" 39 url="$(-antigen-resolve-bundle-url "$url")"
40 40
41 # Add the branch information to the url. 41 # Add the branch information to the url.
42 if [[ ! -z $branch ]]; then 42 if [[ ! -z $branch ]]; then
43 url="$url|$branch" 43 url="$url|$branch"
44 fi 44 fi
45 45
46 # The `make_local_clone` variable better represents whether there should be 46 # The `make_local_clone` variable better represents whether there should be
47 # a local clone made. For cloning to be avoided, firstly, the `$url` should 47 # a local clone made. For cloning to be avoided, firstly, the `$url` should
48 # be an absolute local path and `$branch` should be empty. In addition to 48 # be an absolute local path and `$branch` should be empty. In addition to
49 # these two conditions, either the `--no-local-clone` option should be 49 # these two conditions, either the `--no-local-clone` option should be
50 # given, or `$url` should not a git repo. 50 # given, or `$url` should not a git repo.
51 local make_local_clone=true 51 local make_local_clone=true
52 if [[ $url == /* && -z $branch && 52 if [[ $url == /* && -z $branch &&
53 ( $no_local_clone == true || ! -d $url/.git ) ]]; then 53 ( $no_local_clone == true || ! -d $url/.git ) ]]; then
54 make_local_clone=false 54 make_local_clone=false
55 fi 55 fi
56 56
57 # Add the theme extension to `loc`, if this is a theme. 57 # Add the theme extension to `loc`, if this is a theme.
58 if [[ $btype == theme && $loc != *.zsh-theme ]]; then 58 if [[ $btype == theme && $loc != *.zsh-theme ]]; then
59 loc="$loc.zsh-theme" 59 loc="$loc.zsh-theme"
60 fi 60 fi
61 61
62 # Add it to the record. 62 # Add it to the record.
63 _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD\n$url $loc $btype" 63 _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD\n$url $loc $btype"
64 _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD $make_local_clone" 64 _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD $make_local_clone"
65 65
66 # Ensure a clone exists for this repo, if needed. 66 # Ensure a clone exists for this repo, if needed.
67 if $make_local_clone; then 67 if $make_local_clone; then
68 -antigen-ensure-repo "$url" 68 -antigen-ensure-repo "$url"
69 fi 69 fi
70 70
71 # Load the plugin. 71 # Load the plugin.
72 -antigen-load "$url" "$loc" "$btype" "$make_local_clone" 72 -antigen-load "$url" "$loc" "$btype" "$make_local_clone"
73 73
74 } 74 }
75 75
76 -antigen-resolve-bundle-url () { 76 -antigen-resolve-bundle-url () {
77 # Given an acceptable short/full form of a bundle's repo url, this function 77 # Given an acceptable short/full form of a bundle's repo url, this function
78 # echoes the full form of the repo's clone url. 78 # echoes the full form of the repo's clone url.
79 79
80 local url="$1" 80 local url="$1"
81 81
82 # Expand short github url syntax: `username/reponame`. 82 # Expand short github url syntax: `username/reponame`.
83 if [[ $url != git://* && 83 if [[ $url != git://* &&
84 $url != https://* && 84 $url != https://* &&
85 $url != /* && 85 $url != /* &&
86 $url != git@github.com:*/* 86 $url != git@github.com:*/*
87 ]]; then 87 ]]; then
88 url="https://github.com/${url%.git}.git" 88 url="https://github.com/${url%.git}.git"
89 fi 89 fi
90 90
91 echo "$url" 91 echo "$url"
92 } 92 }
93 93
94 antigen-bundles () { 94 antigen-bundles () {
95 # Bulk add many bundles at one go. Empty lines and lines starting with a `#` 95 # Bulk add many bundles at one go. Empty lines and lines starting with a `#`
96 # are ignored. Everything else is given to `antigen-bundle` as is, no 96 # are ignored. Everything else is given to `antigen-bundle` as is, no
97 # quoting rules applied. 97 # quoting rules applied.
98 98
99 local line 99 local line
100 100
101 grep '^[[:space:]]*[^[:space:]#]' | while read line; do 101 grep '^[[:space:]]*[^[:space:]#]' | while read line; do
102 # Using `eval` so that we can use the shell-style quoting in each line 102 # Using `eval` so that we can use the shell-style quoting in each line
103 # piped to `antigen-bundles`. 103 # piped to `antigen-bundles`.
104 eval "antigen-bundle $line" 104 eval "antigen-bundle $line"
105 done 105 done
106 } 106 }
107 107
108 antigen-update () { 108 antigen-update () {
109 # Update your bundles, i.e., `git pull` in all the plugin repos. 109 # Update your bundles, i.e., `git pull` in all the plugin repos.
110 110
111 date > $ADOTDIR/revert-info 111 date > $ADOTDIR/revert-info
112 112
113 -antigen-echo-record | 113 -antigen-echo-record |
114 awk '$4 == "true" {print $1}' | 114 awk '$4 == "true" {print $1}' |
115 sort -u | 115 sort -u |
116 while read url; do 116 while read url; do
117 echo "**** Pulling $url" 117 echo "**** Pulling $url"
118 118
119 local clone_dir="$(-antigen-get-clone-dir "$url")" 119 local clone_dir="$(-antigen-get-clone-dir "$url")"
120 if [[ -d "$clone_dir" ]]; then 120 if [[ -d "$clone_dir" ]]; then
121 (echo -n "$clone_dir:" 121 (echo -n "$clone_dir:"
122 cd "$clone_dir" 122 cd "$clone_dir"
123 git rev-parse HEAD) >> $ADOTDIR/revert-info 123 git rev-parse HEAD) >> $ADOTDIR/revert-info
124 fi 124 fi
125 125
126 -antigen-ensure-repo "$url" --update --verbose 126 -antigen-ensure-repo "$url" --update --verbose
127 127
128 echo 128 echo
129 done 129 done
130 } 130 }
131 131
132 antigen-revert () { 132 antigen-revert () {
133 if [[ -f $ADOTDIR/revert-info ]]; then 133 if [[ -f $ADOTDIR/revert-info ]]; then
134 cat $ADOTDIR/revert-info | sed '1!p' | while read line; do 134 cat $ADOTDIR/revert-info | sed '1!p' | while read line; do
135 dir="$(echo "$line" | cut -d: -f1)" 135 dir="$(echo "$line" | cut -d: -f1)"
136 git --git-dir="$dir/.git" --work-tree="$dir" \ 136 git --git-dir="$dir/.git" --work-tree="$dir" \
137 checkout "$(echo "$line" | cut -d: -f2)" 2> /dev/null 137 checkout "$(echo "$line" | cut -d: -f2)" 2> /dev/null
138 138
139 done 139 done
140 140
141 echo "Reverted to state before running -update on $( 141 echo "Reverted to state before running -update on $(
142 cat $ADOTDIR/revert-info | sed -n 1p)." 142 cat $ADOTDIR/revert-info | sed -n 1p)."
143 143
144 else 144 else
145 echo 'No revert information available. Cannot revert.' >&2 145 echo 'No revert information available. Cannot revert.' >&2
146 fi 146 fi
147 147
148 148
149 } 149 }
150 150
151 -antigen-get-clone-dir () { 151 -antigen-get-clone-dir () {
152 # Takes a repo url and gives out the path that this url needs to be cloned 152 # Takes a repo url and gives out the path that this url needs to be cloned
153 # to. Doesn't actually clone anything. 153 # to. Doesn't actually clone anything.
154 echo -n $ADOTDIR/repos/ 154 echo -n $ADOTDIR/repos/
155 155
156 if [[ "$1" == "https://github.com/sorin-ionescu/prezto.git" ]]; then 156 if [[ "$1" == "https://github.com/sorin-ionescu/prezto.git" ]]; then
157 # Prezto's directory *has* to be `.zprezto`. 157 # Prezto's directory *has* to be `.zprezto`.
158 echo .zprezto 158 echo .zprezto
159 159
160 else 160 else
161 echo "$1" | sed \ 161 echo "$1" | sed \
162 -e 's./.-SLASH-.g' \ 162 -e 's./.-SLASH-.g' \
163 -e 's.:.-COLON-.g' \ 163 -e 's.:.-COLON-.g' \
164 -e 's.|.-PIPE-.g' 164 -e 's.|.-PIPE-.g'
165 165
166 fi 166 fi
167 } 167 }
168 168
169 -antigen-get-clone-url () { 169 -antigen-get-clone-url () {
170 # Takes a repo's clone dir and gives out the repo's original url that was 170 # Takes a repo's clone dir and gives out the repo's original url that was
171 # used to create the given directory path. 171 # used to create the given directory path.
172 172
173 if [[ "$1" == ".zprezto" ]]; then 173 if [[ "$1" == ".zprezto" ]]; then
174 # Prezto's (in `.zprezto`), is assumed to be from `sorin-ionescu`'s 174 # Prezto's (in `.zprezto`), is assumed to be from `sorin-ionescu`'s
175 # remote. 175 # remote.
176 echo https://github.com/sorin-ionescu/prezto.git 176 echo https://github.com/sorin-ionescu/prezto.git
177 177
178 else 178 else
179 echo "$1" | sed \ 179 echo "$1" | sed \
180 -e "s:^$ADOTDIR/repos/::" \ 180 -e "s:^$ADOTDIR/repos/::" \
181 -e 's.-SLASH-./.g' \ 181 -e 's.-SLASH-./.g' \
182 -e 's.-COLON-.:.g' \ 182 -e 's.-COLON-.:.g' \
183 -e 's.-PIPE-.|.g' 183 -e 's.-PIPE-.|.g'
184 184
185 fi 185 fi
186 } 186 }
187 187
188 -antigen-ensure-repo () { 188 -antigen-ensure-repo () {
189 189
190 # Ensure that a clone exists for the given repo url and branch. If the first 190 # Ensure that a clone exists for the given repo url and branch. If the first
191 # argument is `--update` and if a clone already exists for the given repo 191 # argument is `--update` and if a clone already exists for the given repo
192 # and branch, it is pull-ed, i.e., updated. 192 # and branch, it is pull-ed, i.e., updated.
193 193
194 # Argument defaults. 194 # Argument defaults.
195 # The url. No sane default for this, so just empty. 195 # The url. No sane default for this, so just empty.
196 local url= 196 local url=
197 # Check if we have to update. 197 # Check if we have to update.
198 local update=false 198 local update=false
199 # Verbose output. 199 # Verbose output.
200 local verbose=false 200 local verbose=false
201 201
202 eval "$(-antigen-parse-args 'url ; update?, verbose?' "$@")" 202 eval "$(-antigen-parse-args 'url ; update?, verbose?' "$@")"
203 shift $# 203 shift $#
204 204
205 # Get the clone's directory as per the given repo url and branch. 205 # Get the clone's directory as per the given repo url and branch.
206 local clone_dir="$(-antigen-get-clone-dir $url)" 206 local clone_dir="$(-antigen-get-clone-dir $url)"
207 207
208 # A temporary function wrapping the `git` command with repeated arguments. 208 # A temporary function wrapping the `git` command with repeated arguments.
209 --plugin-git () { 209 --plugin-git () {
210 (cd "$clone_dir" && git --no-pager "$@") 210 (cd "$clone_dir" && git --no-pager "$@")
211 } 211 }
212 212
213 # Clone if it doesn't already exist. 213 # Clone if it doesn't already exist.
214 if [[ ! -d $clone_dir ]]; then 214 if [[ ! -d $clone_dir ]]; then
215 git clone --recursive "${url%|*}" "$clone_dir" 215 git clone --recursive "${url%|*}" "$clone_dir"
216 elif $update; then 216 elif $update; then
217 # Save current revision. 217 # Save current revision.
218 local old_rev="$(--plugin-git rev-parse HEAD)" 218 local old_rev="$(--plugin-git rev-parse HEAD)"
219 # Pull changes if update requested. 219 # Pull changes if update requested.
220 --plugin-git pull 220 --plugin-git pull
221 # Update submodules. 221 # Update submodules.
222 --plugin-git submodule update --recursive 222 --plugin-git submodule update --recursive
223 # Get the new revision. 223 # Get the new revision.
224 local new_rev="$(--plugin-git rev-parse HEAD)" 224 local new_rev="$(--plugin-git rev-parse HEAD)"
225 fi 225 fi
226 226
227 # If its a specific branch that we want, checkout that branch. 227 # If its a specific branch that we want, checkout that branch.
228 if [[ $url == *\|* ]]; then 228 if [[ $url == *\|* ]]; then
229 local current_branch=${$(--plugin-git symbolic-ref HEAD)##refs/heads/} 229 local current_branch=${$(--plugin-git symbolic-ref HEAD)##refs/heads/}
230 local requested_branch="${url#*|}" 230 local requested_branch="${url#*|}"
231 # Only do the checkout when we are not already on the branch. 231 # Only do the checkout when we are not already on the branch.
232 [[ $requested_branch != $current_branch ]] && 232 [[ $requested_branch != $current_branch ]] &&
233 --plugin-git checkout $requested_branch 233 --plugin-git checkout $requested_branch
234 fi 234 fi
235 235
236 if [[ -n $old_rev && $old_rev != $new_rev ]]; then 236 if [[ -n $old_rev && $old_rev != $new_rev ]]; then
237 echo Updated from ${old_rev:0:7} to ${new_rev:0:7}. 237 echo Updated from ${old_rev:0:7} to ${new_rev:0:7}.
238 if $verbose; then 238 if $verbose; then
239 --plugin-git log --oneline --reverse --no-merges --stat '@{1}..' 239 --plugin-git log --oneline --reverse --no-merges --stat '@{1}..'
240 fi 240 fi
241 fi 241 fi
242 242
243 # Remove the temporary git wrapper function. 243 # Remove the temporary git wrapper function.
244 unfunction -- --plugin-git 244 unfunction -- --plugin-git
245 245
246 } 246 }
247 247
248 -antigen-load () { 248 -antigen-load () {
249 249
250 local url="$1" 250 local url="$1"
251 local loc="$2" 251 local loc="$2"
252 local btype="$3" 252 local btype="$3"
253 local make_local_clone="$4" 253 local make_local_clone="$4"
254 254
255 # The full location where the plugin is located. 255 # The full location where the plugin is located.
256 local location 256 local location
257 if $make_local_clone; then 257 if $make_local_clone; then
258 location="$(-antigen-get-clone-dir "$url")/$loc" 258 location="$(-antigen-get-clone-dir "$url")/$loc"
259 else 259 else
260 location="$url" 260 location="$url"
261 fi 261 fi
262 262
263 if [[ $btype == theme ]]; then 263 if [[ $btype == theme ]]; then
264 264
265 # Of course, if its a theme, the location would point to the script 265 # Of course, if its a theme, the location would point to the script
266 # file. 266 # file.
267 source "$location" 267 source "$location"
268 268
269 else 269 else
270 270
271 # Source the plugin script. 271 # Source the plugin script.
272 # FIXME: I don't know. Looks very very ugly. Needs a better 272 # FIXME: I don't know. Looks very very ugly. Needs a better
273 # implementation once tests are ready. 273 # implementation once tests are ready.
274 local script_loc="$(ls "$location" | grep -m1 '\.plugin\.zsh$')" 274 local script_loc="$(ls "$location" | grep -m1 '\.plugin\.zsh$')"
275 275
276 if [[ -f $location/$script_loc ]]; then 276 if [[ -f $location/$script_loc ]]; then
277 # If we have a `*.plugin.zsh`, source it. 277 # If we have a `*.plugin.zsh`, source it.
278 source "$location/$script_loc" 278 source "$location/$script_loc"
279 279
280 elif [[ -f $location/init.zsh ]]; then 280 elif [[ -f $location/init.zsh ]]; then
281 # If we have a `init.zsh` 281 # If we have a `init.zsh`
282 if (( $+functions[pmodload] )); then 282 if (( $+functions[pmodload] )); then
283 # If pmodload is defined pmodload the module. Remove `modules/` 283 # If pmodload is defined pmodload the module. Remove `modules/`
284 # from loc to find module name. 284 # from loc to find module name.
285 pmodload "${loc#modules/}" 285 pmodload "${loc#modules/}"
286 else 286 else
287 # Otherwise source it. 287 # Otherwise source it.
288 source "$location/init.zsh" 288 source "$location/init.zsh"
289 fi 289 fi
290 290
291 elif ls "$location" | grep -qm1 '\.zsh$'; then 291 elif ls "$location" | grep -qm1 '\.zsh$'; then
292 # If there is no `*.plugin.zsh` file, source *all* the `*.zsh` 292 # If there is no `*.plugin.zsh` file, source *all* the `*.zsh`
293 # files. 293 # files.
294 for script ($location/*.zsh(N)) source "$script" 294 for script ($location/*.zsh(N)) source "$script"
295 295
296 elif ls "$location" | grep -qm1 '\.sh$'; then 296 elif ls "$location" | grep -qm1 '\.sh$'; then
297 # If there are no `*.zsh` files either, we look for and source any 297 # If there are no `*.zsh` files either, we look for and source any
298 # `*.sh` files instead. 298 # `*.sh` files instead.
299 for script ($location/*.sh(N)) source "$script" 299 for script ($location/*.sh(N)) source "$script"
300 300
301 fi 301 fi
302 302
303 # Add to $fpath, for completion(s). 303 # Add to $fpath, for completion(s).
304 fpath=($location $fpath) 304 fpath=($location $fpath)
305 305
306 fi 306 fi
307 307
308 } 308 }
309 309
310 # Update (with `git pull`) antigen itself. 310 # Update (with `git pull`) antigen itself.
311 # TODO: Once update is finished, show a summary of the new commits, as a kind of 311 # TODO: Once update is finished, show a summary of the new commits, as a kind of
312 # "what's new" message. 312 # "what's new" message.
313 antigen-selfupdate () { 313 antigen-selfupdate () {
314 ( cd $_ANTIGEN_INSTALL_DIR 314 ( cd $_ANTIGEN_INSTALL_DIR
315 if [[ ! -d .git ]]; then 315 if [[ ! -d .git ]]; then
316 echo "Your copy of antigen doesn't appear to be a git clone. " \ 316 echo "Your copy of antigen doesn't appear to be a git clone. " \
317 "The 'selfupdate' command cannot work in this case." 317 "The 'selfupdate' command cannot work in this case."
318 return 1 318 return 1
319 fi 319 fi
320 git pull 320 git pull
321 ) 321 )
322 } 322 }
323 323
324 antigen-cleanup () { 324 antigen-cleanup () {
325 325
326 # Cleanup unused repositories. 326 # Cleanup unused repositories.
327 327
328 local force=false 328 local force=false
329 if [[ $1 == --force ]]; then 329 if [[ $1 == --force ]]; then
330 force=true 330 force=true
331 fi 331 fi
332 332
333 if [[ ! -d "$ADOTDIR/repos" || -z "$(ls "$ADOTDIR/repos/")" ]]; then 333 if [[ ! -d "$ADOTDIR/repos" || -z "$(ls "$ADOTDIR/repos/")" ]]; then
334 echo "You don't have any bundles." 334 echo "You don't have any bundles."
335 return 0 335 return 0
336 fi 336 fi
337 337
338 # Find directores in ADOTDIR/repos, that are not in the bundles record. 338 # Find directores in ADOTDIR/repos, that are not in the bundles record.
339 local unused_clones="$(comm -13 \ 339 local unused_clones="$(comm -13 \
340 <(-antigen-echo-record | 340 <(-antigen-echo-record |
341 awk '$4 == "true" {print $1}' | 341 awk '$4 == "true" {print $1}' |
342 while read line; do 342 while read line; do
343 -antigen-get-clone-dir "$line" 343 -antigen-get-clone-dir "$line"
344 done | 344 done |
345 sort -u) \ 345 sort -u) \
346 <(ls -d "$ADOTDIR/repos/"* | sort -u))" 346 <(ls -d "$ADOTDIR/repos/"* | sort -u))"
347 347
348 if [[ -z $unused_clones ]]; then 348 if [[ -z $unused_clones ]]; then
349 echo "You don't have any unidentified bundles." 349 echo "You don't have any unidentified bundles."
350 return 0 350 return 0
351 fi 351 fi
352 352
353 echo 'You have clones for the following repos, but are not used.' 353 echo 'You have clones for the following repos, but are not used.'
354 echo "$unused_clones" | 354 echo "$unused_clones" |
355 while read line; do 355 while read line; do
356 -antigen-get-clone-url "$line" 356 -antigen-get-clone-url "$line"
357 done | 357 done |
358 sed -e 's/^/ /' -e 's/|/, branch /' 358 sed -e 's/^/ /' -e 's/|/, branch /'
359 359
360 if $force || (echo -n '\nDelete them all? [y/N] '; read -q); then 360 if $force || (echo -n '\nDelete them all? [y/N] '; read -q); then
361 echo 361 echo
362 echo 362 echo
363 echo "$unused_clones" | while read line; do 363 echo "$unused_clones" | while read line; do
364 echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..." 364 echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..."
365 rm -rf "$line" 365 rm -rf "$line"
366 echo ' done.' 366 echo ' done.'
367 done 367 done
368 else 368 else
369 echo 369 echo
370 echo Nothing deleted. 370 echo Nothing deleted.
371 fi 371 fi
372 } 372 }
373 373
374 antigen-use () { 374 antigen-use () {
375 if [[ $1 == "oh-my-zsh" ]]; then 375 if [[ $1 == oh-my-zsh ]]; then
376 antigen-lib $@ 376 antigen-lib $@
377 elif [[ $1 == "prezto" ]]; then 377 elif [[ $1 == prezto ]]; then
378 antigen-prezto-lib $@ 378 antigen-prezto-lib $@
379 else 379 else
380 echo 'Antigen currently supports only following libraries:' >&2 380 echo 'Usage: antigen-use <library-name>' >&2
381 echo 'Where <library-name> is any one of the following:' >&2
381 echo ' * oh-my-zsh' >&2 382 echo ' * oh-my-zsh' >&2
382 echo ' * prezto' >&2 383 echo ' * prezto' >&2
383 return 1 384 return 1
384 fi 385 fi
385 } 386 }
386 387
387 antigen-lib () { 388 antigen-lib () {
388 if [[ -z "$ZSH" ]]; then 389 if [[ -z "$ZSH" ]]; then
389 export ZSH="$(-antigen-get-clone-dir "$ANTIGEN_DEFAULT_REPO_URL")" 390 export ZSH="$(-antigen-get-clone-dir "$ANTIGEN_DEFAULT_REPO_URL")"
390 fi 391 fi
391 antigen-bundle --loc=lib 392 antigen-bundle --loc=lib
392 } 393 }
393 394
394 antigen-prezto-lib () { 395 antigen-prezto-lib () {
395 antigen-bundle sorin-ionescu/prezto 396 antigen-bundle sorin-ionescu/prezto
396 export ZDOTDIR=$ADOTDIR/repos/ 397 export ZDOTDIR=$ADOTDIR/repos/
397 } 398 }
398 399
399 antigen-theme () { 400 antigen-theme () {
400 401
401 if [[ "$1" != */* && "$1" != --* ]]; then 402 if [[ "$1" != */* && "$1" != --* ]]; then
402 # The first argument is just a name of the plugin, to be picked up from 403 # The first argument is just a name of the plugin, to be picked up from
403 # the default repo. 404 # the default repo.
404 local name="${1:-robbyrussell}" 405 local name="${1:-robbyrussell}"
405 antigen-bundle --loc=themes/$name --btype=theme 406 antigen-bundle --loc=themes/$name --btype=theme
406 407
407 else 408 else
408 antigen-bundle "$@" --btype=theme 409 antigen-bundle "$@" --btype=theme
409 410
410 fi 411 fi
411 412
412 } 413 }
413 414
414 antigen-apply () { 415 antigen-apply () {
415 416
416 # Initialize completion. 417 # Initialize completion.
417 local cdef 418 local cdef
418 419
419 # Load the compinit module. This will readefine the `compdef` function to 420 # Load the compinit module. This will readefine the `compdef` function to
420 # the one that actually initializes completions. 421 # the one that actually initializes completions.
421 autoload -U compinit 422 autoload -U compinit
422 compinit -i 423 compinit -i
423 424
424 # Apply all `compinit`s that have been deferred. 425 # Apply all `compinit`s that have been deferred.
425 eval "$(for cdef in $__deferred_compdefs; do 426 eval "$(for cdef in $__deferred_compdefs; do
426 echo compdef $cdef 427 echo compdef $cdef
427 done)" 428 done)"
428 429
429 unset __deferred_compdefs 430 unset __deferred_compdefs
430 431
431 } 432 }
432 433
433 antigen-list () { 434 antigen-list () {
434 # List all currently installed bundles. 435 # List all currently installed bundles.
435 if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then 436 if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then
436 echo "You don't have any bundles." >&2 437 echo "You don't have any bundles." >&2
437 return 1 438 return 1
438 else 439 else
439 -antigen-echo-record | sort -u 440 -antigen-echo-record | sort -u
440 fi 441 fi
441 } 442 }
442 443
443 antigen-snapshot () { 444 antigen-snapshot () {
444 445
445 local snapshot_file="${1:-antigen-shapshot}" 446 local snapshot_file="${1:-antigen-shapshot}"
446 447
447 # The snapshot content lines are pairs of repo-url and git version hash, in 448 # The snapshot content lines are pairs of repo-url and git version hash, in
448 # the form: 449 # the form:
449 # <version-hash> <repo-url> 450 # <version-hash> <repo-url>
450 local snapshot_content="$(-antigen-echo-record | 451 local snapshot_content="$(-antigen-echo-record |
451 grep 'true$' | 452 grep 'true$' |
452 sed 's/ .*$//' | 453 sed 's/ .*$//' |
453 sort -u | 454 sort -u |
454 while read url; do 455 while read url; do
455 local dir="$(-antigen-get-clone-dir "$url")" 456 local dir="$(-antigen-get-clone-dir "$url")"
456 local version_hash="$(cd "$dir" && git rev-parse HEAD)" 457 local version_hash="$(cd "$dir" && git rev-parse HEAD)"
457 echo "$version_hash $url" 458 echo "$version_hash $url"
458 done)" 459 done)"
459 460
460 { 461 {
461 # The first line in the snapshot file is for metadata, in the form: 462 # The first line in the snapshot file is for metadata, in the form:
462 # key='value'; key='value'; key='value'; 463 # key='value'; key='value'; key='value';
463 # Where `key`s are valid shell variable names. 464 # Where `key`s are valid shell variable names.
464 465
465 # Snapshot version. Has no relation to antigen version. If the snapshot 466 # Snapshot version. Has no relation to antigen version. If the snapshot
466 # file format changes, this number can be incremented. 467 # file format changes, this number can be incremented.
467 echo -n "version='1';" 468 echo -n "version='1';"
468 469
469 # Snapshot creation date+time. 470 # Snapshot creation date+time.
470 echo -n " created_on='$(date)';" 471 echo -n " created_on='$(date)';"
471 472
472 # Add a checksum with the md5 checksum of all the snapshot lines. 473 # Add a checksum with the md5 checksum of all the snapshot lines.
473 local checksum="$(echo "$snapshot_content" | md5sum)" 474 local checksum="$(echo "$snapshot_content" | md5sum)"
474 echo -n " checksum='${checksum%% *}';" 475 echo -n " checksum='${checksum%% *}';"
475 476
476 # A newline after the metadata and then the snapshot lines. 477 # A newline after the metadata and then the snapshot lines.
477 echo "\n$snapshot_content" 478 echo "\n$snapshot_content"
478 479
479 } > "$snapshot_file" 480 } > "$snapshot_file"
480 481
481 } 482 }
482 483
483 antigen-restore () { 484 antigen-restore () {
484 485
485 if [[ $# == 0 ]]; then 486 if [[ $# == 0 ]]; then
486 echo 'Please provide a snapshot file to restore from.' >&2 487 echo 'Please provide a snapshot file to restore from.' >&2
487 return 1 488 return 1
488 fi 489 fi
489 490
490 local snapshot_file="$1" 491 local snapshot_file="$1"
491 492
492 # TODO: Before doing anything with the snapshot file, verify its checksum. 493 # TODO: Before doing anything with the snapshot file, verify its checksum.
493 # If it fails, notify this to the user and confirm if restore should 494 # If it fails, notify this to the user and confirm if restore should
494 # proceed. 495 # proceed.
495 496
496 echo -n "Restoring from $snapshot_file..." 497 echo -n "Restoring from $snapshot_file..."
497 498
498 sed -n '1!p' "$snapshot_file" | 499 sed -n '1!p' "$snapshot_file" |
499 while read line; do 500 while read line; do
500 501
501 local version_hash="${line%% *}" 502 local version_hash="${line%% *}"
502 local url="${line##* }" 503 local url="${line##* }"
503 local clone_dir="$(-antigen-get-clone-dir "$url")" 504 local clone_dir="$(-antigen-get-clone-dir "$url")"
504 505
505 if [[ ! -d $clone_dir ]]; then 506 if [[ ! -d $clone_dir ]]; then
506 git clone "$url" "$clone_dir" > /dev/null 507 git clone "$url" "$clone_dir" > /dev/null
507 fi 508 fi
508 509
509 (cd "$clone_dir" && git checkout $version_hash) 2> /dev/null 510 (cd "$clone_dir" && git checkout $version_hash) 2> /dev/null
510 511
511 done 512 done
512 513
513 echo ' done.' 514 echo ' done.'
514 echo 'Please open a new shell to get the restored changes.' 515 echo 'Please open a new shell to get the restored changes.'
515 } 516 }
516 517
517 antigen-help () { 518 antigen-help () {
518 cat <<EOF 519 cat <<EOF
519 Antigen is a plugin management system for zsh. It makes it easy to grab awesome 520 Antigen is a plugin management system for zsh. It makes it easy to grab awesome
520 shell scripts and utilities, put up on github. For further details and complete 521 shell scripts and utilities, put up on github. For further details and complete
521 documentation, visit the project's page at 'http://antigen.sharats.me'. 522 documentation, visit the project's page at 'http://antigen.sharats.me'.
522 EOF 523 EOF
523 } 524 }
524 525
525 # A syntax sugar to avoid the `-` when calling antigen commands. With this 526 # A syntax sugar to avoid the `-` when calling antigen commands. With this
526 # function, you can write `antigen-bundle` as `antigen bundle` and so on. 527 # function, you can write `antigen-bundle` as `antigen bundle` and so on.
527 antigen () { 528 antigen () {
528 local cmd="$1" 529 local cmd="$1"
529 shift 530 shift
530 "antigen-$cmd" "$@" 531 "antigen-$cmd" "$@"
531 } 532 }
532 533
533 -antigen-parse-args () { 534 -antigen-parse-args () {
534 # An argument parsing functionality to parse arguments the *antigen* way :). 535 # An argument parsing functionality to parse arguments the *antigen* way :).
535 # Takes one first argument (called spec), which dictates how to parse and 536 # Takes one first argument (called spec), which dictates how to parse and
536 # the rest of the arguments are parsed. Outputs a piece of valid shell code 537 # the rest of the arguments are parsed. Outputs a piece of valid shell code
537 # that can be passed to `eval` inside a function which creates the arguments 538 # that can be passed to `eval` inside a function which creates the arguments
538 # and their values as local variables. Suggested use is to set the defaults 539 # and their values as local variables. Suggested use is to set the defaults
539 # to all arguments first and then eval the output of this function. 540 # to all arguments first and then eval the output of this function.
540 541
541 # Spec: Only long argument supported. No support for parsing short options. 542 # Spec: Only long argument supported. No support for parsing short options.
542 # The spec must have two sections, separated by a `;`. 543 # The spec must have two sections, separated by a `;`.
543 # '<positional-arguments>;<keyword-only-arguments>' 544 # '<positional-arguments>;<keyword-only-arguments>'
544 # Positional arguments are passed as just values, like `command a b`. 545 # Positional arguments are passed as just values, like `command a b`.
545 # Keyword arguments are passed as a `--name=value` pair, like `command 546 # Keyword arguments are passed as a `--name=value` pair, like `command
546 # --arg1=a --arg2=b`. 547 # --arg1=a --arg2=b`.
547 548
548 # Each argument in the spec is separated by a `,`. Each keyword argument can 549 # Each argument in the spec is separated by a `,`. Each keyword argument can
549 # end in a `:` to specifiy that this argument wants a value, otherwise it 550 # end in a `:` to specifiy that this argument wants a value, otherwise it
550 # doesn't take a value. (The value in the output when the keyword argument 551 # doesn't take a value. (The value in the output when the keyword argument
551 # doesn't have a `:` is `true`). 552 # doesn't have a `:` is `true`).
552 553
553 # Arguments in either section can end with a `?` (should come after `:`, if 554 # Arguments in either section can end with a `?` (should come after `:`, if
554 # both are present), means optional. FIXME: Not yet implemented. 555 # both are present), means optional. FIXME: Not yet implemented.
555 556
556 # See the test file, tests/arg-parser.t for (working) examples. 557 # See the test file, tests/arg-parser.t for (working) examples.
557 558
558 local spec="$1" 559 local spec="$1"
559 shift 560 shift
560 561
561 # Sanitize the spec 562 # Sanitize the spec
562 spec="$(echo "$spec" | tr '\n' ' ' | sed 's/[[:space:]]//g')" 563 spec="$(echo "$spec" | tr '\n' ' ' | sed 's/[[:space:]]//g')"
563 564
564 local code='' 565 local code=''
565 566
566 --add-var () { 567 --add-var () {
567 test -z "$code" || code="$code\n" 568 test -z "$code" || code="$code\n"
568 code="${code}local $1='$2'" 569 code="${code}local $1='$2'"
569 } 570 }
570 571
571 local positional_args="$(echo "$spec" | cut -d\; -f1)" 572 local positional_args="$(echo "$spec" | cut -d\; -f1)"
572 local positional_args_count="$(echo $positional_args | 573 local positional_args_count="$(echo $positional_args |
573 awk -F, '{print NF}')" 574 awk -F, '{print NF}')"
574 575
575 # Set spec values based on the positional arguments. 576 # Set spec values based on the positional arguments.
576 local i=1 577 local i=1
577 while [[ -n $1 && $1 != --* ]]; do 578 while [[ -n $1 && $1 != --* ]]; do
578 579
579 if (( $i > $positional_args_count )); then 580 if (( $i > $positional_args_count )); then
580 echo "Only $positional_args_count positional arguments allowed." >&2 581 echo "Only $positional_args_count positional arguments allowed." >&2
581 echo "Found at least one more: '$1'" >&2 582 echo "Found at least one more: '$1'" >&2
582 return 583 return
583 fi 584 fi
584 585
585 local name_spec="$(echo "$positional_args" | cut -d, -f$i)" 586 local name_spec="$(echo "$positional_args" | cut -d, -f$i)"
586 local name="${${name_spec%\?}%:}" 587 local name="${${name_spec%\?}%:}"
587 local value="$1" 588 local value="$1"
588 589
589 if echo "$code" | grep -qm1 "^local $name="; then 590 if echo "$code" | grep -qm1 "^local $name="; then
590 echo "Argument '$name' repeated with the value '$value'". >&2 591 echo "Argument '$name' repeated with the value '$value'". >&2
591 return 592 return
592 fi 593 fi
593 594
594 --add-var $name "$value" 595 --add-var $name "$value"
595 596
596 shift 597 shift
597 i=$(($i + 1)) 598 i=$(($i + 1))
598 done 599 done
599 600
600 local keyword_args="$( 601 local keyword_args="$(
601 # Positional arguments can double up as keyword arguments too. 602 # Positional arguments can double up as keyword arguments too.
602 echo "$positional_args" | tr , '\n' | 603 echo "$positional_args" | tr , '\n' |
603 while read line; do 604 while read line; do
604 if [[ $line == *\? ]]; then 605 if [[ $line == *\? ]]; then
605 echo "${line%?}:?" 606 echo "${line%?}:?"
606 else 607 else
607 echo "$line:" 608 echo "$line:"
608 fi 609 fi
609 done 610 done
610 611
611 # Specified keyword arguments. 612 # Specified keyword arguments.
612 echo "$spec" | cut -d\; -f2 | tr , '\n' 613 echo "$spec" | cut -d\; -f2 | tr , '\n'
613 )" 614 )"
614 local keyword_args_count="$(echo $keyword_args | awk -F, '{print NF}')" 615 local keyword_args_count="$(echo $keyword_args | awk -F, '{print NF}')"
615 616
616 # Set spec values from keyword arguments, if any. The remaining arguments 617 # Set spec values from keyword arguments, if any. The remaining arguments
617 # are all assumed to be keyword arguments. 618 # are all assumed to be keyword arguments.
618 while [[ $1 == --* ]]; do 619 while [[ $1 == --* ]]; do
619 # Remove the `--` at the start. 620 # Remove the `--` at the start.
620 local arg="${1#--}" 621 local arg="${1#--}"
621 622
622 # Get the argument name and value. 623 # Get the argument name and value.
623 if [[ $arg != *=* ]]; then 624 if [[ $arg != *=* ]]; then
624 local name="$arg" 625 local name="$arg"
625 local value='' 626 local value=''
626 else 627 else
627 local name="${arg%\=*}" 628 local name="${arg%\=*}"
628 local value="${arg#*=}" 629 local value="${arg#*=}"
629 fi 630 fi
630 631
631 if echo "$code" | grep -qm1 "^local $name="; then 632 if echo "$code" | grep -qm1 "^local $name="; then
632 echo "Argument '$name' repeated with the value '$value'". >&2 633 echo "Argument '$name' repeated with the value '$value'". >&2
633 return 634 return
634 fi 635 fi
635 636
636 # The specification for this argument, used for validations. 637 # The specification for this argument, used for validations.
637 local arg_line="$(echo "$keyword_args" | grep -m1 "^$name:\??\?")" 638 local arg_line="$(echo "$keyword_args" | grep -m1 "^$name:\??\?")"
638 639
639 # Validate argument and value. 640 # Validate argument and value.
640 if [[ -z $arg_line ]]; then 641 if [[ -z $arg_line ]]; then
641 # This argument is not known to us. 642 # This argument is not known to us.
642 echo "Unknown argument '$name'." >&2 643 echo "Unknown argument '$name'." >&2
643 return 644 return
644 645
645 elif (echo "$arg_line" | grep -qm1 ':') && [[ -z $value ]]; then 646 elif (echo "$arg_line" | grep -qm1 ':') && [[ -z $value ]]; then
646 # This argument needs a value, but is not provided. 647 # This argument needs a value, but is not provided.
647 echo "Required argument for '$name' not provided." >&2 648 echo "Required argument for '$name' not provided." >&2
648 return 649 return
649 650
650 elif (echo "$arg_line" | grep -vqm1 ':') && [[ ! -z $value ]]; then 651 elif (echo "$arg_line" | grep -vqm1 ':') && [[ ! -z $value ]]; then
651 # This argument doesn't need a value, but is provided. 652 # This argument doesn't need a value, but is provided.
652 echo "No argument required for '$name', but provided '$value'." >&2 653 echo "No argument required for '$name', but provided '$value'." >&2
653 return 654 return
654 655
655 fi 656 fi
656 657
657 if [[ -z $value ]]; then 658 if [[ -z $value ]]; then
658 value=true 659 value=true
659 fi 660 fi
660 661
661 --add-var "${name//-/_}" "$value" 662 --add-var "${name//-/_}" "$value"
662 shift 663 shift
663 done 664 done
664 665
665 echo "$code" 666 echo "$code"
666 667
667 unfunction -- --add-var 668 unfunction -- --add-var
668 669
669 } 670 }
670 671
671 # Echo the bundle specs as in the record. The first line is not echoed since it 672 # Echo the bundle specs as in the record. The first line is not echoed since it
672 # is a blank line. 673 # is a blank line.
673 -antigen-echo-record () { 674 -antigen-echo-record () {
674 echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p' 675 echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p'
675 } 676 }
676 677
677 -antigen-env-setup () { 678 -antigen-env-setup () {
678 679
679 # Helper function: Same as `export $1=$2`, but will only happen if the name 680 # Helper function: Same as `export $1=$2`, but will only happen if the name
680 # specified by `$1` is not already set. 681 # specified by `$1` is not already set.
681 -set-default () { 682 -set-default () {
682 local arg_name="$1" 683 local arg_name="$1"
683 local arg_value="$2" 684 local arg_value="$2"
684 eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'" 685 eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'"
685 } 686 }
686 687
687 # Pre-startup initializations. 688 # Pre-startup initializations.
688 -set-default ANTIGEN_DEFAULT_REPO_URL \ 689 -set-default ANTIGEN_DEFAULT_REPO_URL \
689 https://github.com/robbyrussell/oh-my-zsh.git 690 https://github.com/robbyrussell/oh-my-zsh.git
690 -set-default ADOTDIR $HOME/.antigen 691 -set-default ADOTDIR $HOME/.antigen
691 692
692 # Setup antigen's own completion. 693 # Setup antigen's own completion.
693 compdef _antigen antigen 694 compdef _antigen antigen
694 695
695 # Remove private functions. 696 # Remove private functions.
696 unfunction -- -set-default 697 unfunction -- -set-default
697 } 698 }
698 699
699 # Setup antigen's autocompletion 700 # Setup antigen's autocompletion
700 _antigen () { 701 _antigen () {
701 compadd \ 702 compadd \
702 bundle \ 703 bundle \
703 bundles \ 704 bundles \
704 update \ 705 update \
705 revert \ 706 revert \
706 list \ 707 list \
707 cleanup \ 708 cleanup \
708 lib \ 709 lib \
709 selfupdate \ 710 selfupdate \
710 theme \ 711 theme \
711 apply \ 712 apply \
712 help 713 help
713 } 714 }
714 715
715 -antigen-env-setup 716 -antigen-env-setup
716 717