antigen.zsh
10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
#!/bin/zsh
# Each line in this string has the following entries separated by a space
# character.
# <repo-url>, <plugin-location>, <bundle-type>
# FIXME: Is not kept local by zsh!
local _ANTIGEN_BUNDLE_RECORD=""
# Syntaxes
# antigen-bundle <url> [<loc>=/]
# Keyword only arguments:
# branch - The branch of the repo to use for this bundle.
antigen-bundle () {
# Bundle spec arguments' default values.
local url="$ANTIGEN_DEFAULT_REPO_URL"
local loc=/
local branch=
local no_local_clone=false
local btype=plugin
# Set spec values based on the positional arguments.
local position_args
position_args=(url loc)
local i=1
while ! [[ -z $1 || $1 == --* ]]; do
local arg_name="${position_args[$i]}"
local arg_value="$1"
eval "local $arg_name='$arg_value'"
shift
i=$(($i + 1))
done
# Set spec values from keyword arguments, if any. The remaining arguments
# are all assumed to be keyword arguments.
while [[ $1 == --* ]]; do
# Remove the `--` at the start.
local arg="${1#--}"
if [[ $arg != *=* ]]; then
arg="$arg=true"
fi
# Get the name of the arg and replace the `-`'s to `_`'s.
local arg_name="${${arg%\=*}//-/_}"
# Get the value of the arg.
local arg_value="${arg#*\=}"
eval "local $arg_name='$arg_value'"
shift
done
# Check if url is just the plugin name. Super short syntax.
if [[ "$url" != */* ]]; then
loc="plugins/$url"
url="$ANTIGEN_DEFAULT_REPO_URL"
fi
# Resolve the url.
url="$(-antigen-resolve-bundle-url "$url")"
# Add the branch information to the url.
if [[ ! -z $branch ]]; then
url="$url|$branch"
fi
# The `make_local_clone` variable better represents whether there should be
# a local clone made. For cloning to be avoided, firstly, the `$url` should
# be an absolute local path and `$branch` should be empty. In addition to
# these two conditions, either the `--no-local-clone` option should be
# given, or `$url` should not a git repo.
local make_local_clone=true
if [[ $url == /* && -z $branch \
&& ( $no_local_clone == true || ! -d $url/.git ) ]]; then
make_local_clone=false
fi
# Add it to the record.
_ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD\n$url $loc $btype $make_local_clone"
# Ensure a clone exists for this repo, if needed.
if $make_local_clone; then
-antigen-ensure-repo "$url"
fi
# Load the plugin.
-antigen-load "$url" "$loc" "$btype" "$make_local_clone"
}
-antigen-resolve-bundle-url () {
# Given an acceptable short/full form of a bundle's repo url, this function
# echoes the full form of the repo's clone url.
local url="$1"
# Expand short github url syntax: `username/reponame`
if [[ $url != git://* && \
$url != https://* && \
$url != /* && \
$url != git@github.com:*/*
]]; then
url="https://github.com/${url%.git}.git"
fi
echo "$url"
}
antigen-bundles () {
# Bulk add many bundles at one go. Empty lines and lines starting with a `#`
# are ignored. Everything else is given to `antigen-bundle` as is, no
# quoting rules applied.
local line
grep -v '^\s*$\|^#' | while read line; do
# Using `eval` so that we can use the shell-style quoting in each line
# piped to `antigen-bundles`.
eval "antigen-bundle $line"
done
}
antigen-update () {
# Update your bundles, i.e., `git pull` in all the plugin repos.
-antigen-echo-record \
| awk '{print $1}' \
| sort -u \
| while read url; do
echo "**** Pulling $url"
-antigen-ensure-repo --update --verbose "$url"
echo
done
}
-antigen-get-clone-dir () {
# Takes a repo url and gives out the path that this url needs to be cloned
# to. Doesn't actually clone anything.
# TODO: Memoize?
# The url given.
local url="$1"
# Echo the full path to the clone directory.
echo -n $ADOTDIR/repos/
echo "$url" | sed \
-e 's./.-SLASH-.g' \
-e 's.:.-COLON-.g' \
-e 's.|.-PIPE-.g'
}
-antigen-get-clone-url () {
# Takes a repo's clone dir and gives out the repo's original url that was
# used to create the given directory path.
# TODO: Memoize?
echo "$1" | sed \
-e "s:^$ADOTDIR/repos/::" \
-e 's.-SLASH-./.g' \
-e 's.-COLON-.:.g' \
-e 's.-PIPE-.|.g'
}
-antigen-ensure-repo () {
# Ensure that a clone exists for the given repo url and branch. If the first
# argument is `--update` and if a clone already exists for the given repo
# and branch, it is pull-ed, i.e., updated.
# Argument defaults.
# Check if we have to update.
local update=false
# Verbose output.
local verbose=false
# Load any boolean arguments specified.
while [[ $1 == --* ]]; do
eval "local '${1#--}=true'"
shift
done
# Get the clone's directory as per the given repo url and branch.
local url="$1"
local clone_dir="$(-antigen-get-clone-dir $url)"
# Clone if it doesn't already exist.
if [[ ! -d $clone_dir ]]; then
git clone "${url%|*}" "$clone_dir"
elif $update; then
# Save current revision.
old_rev="$(git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
rev-parse HEAD)"
# Pull changes if update requested.
git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
pull
# Get the new revision.
new_rev="$(git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
rev-parse HEAD)"
fi
# If its a specific branch that we want, checkout that branch.
if [[ $url == *\|* ]]; then
git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
checkout "${url#*|}"
fi
if ! [[ -z $old_rev || $old_rev == $new_rev ]]; then
echo Updated from ${old_rev:0:7} to ${new_rev:0:7}.
if $verbose; then
git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
log --oneline --reverse --no-merges --stat '@{1}..'
fi
fi
}
-antigen-load () {
local url="$1"
local loc="$2"
local btype="$3"
local make_local_clone="$4"
# The full location where the plugin is located.
local location
if $make_local_clone; then
location="$(-antigen-get-clone-dir "$url")/$loc"
else
location="$url"
fi
if [[ $btype == theme ]]; then
# Of course, if its a theme, the location would point to the script
# file.
source "$location"
else
# Source the plugin script
# FIXME: I don't know. Looks very very ugly. Needs a better
# implementation once tests are ready.
local script_loc="$(ls "$location" | grep -m1 '\.plugin\.zsh$')"
if [[ -f $script_loc ]]; then
# If we have a `*.plugin.zsh`, source it.
source "$script_loc"
elif [[ ! -z "$(ls "$location" | grep -m1 '\.zsh$')" ]]; then
# If there is no `*.plugin.zsh` file, source *all* the `*.zsh`
# files.
for script ($location/*.zsh(N)) source "$script"
elif [[ ! -z "$(ls "$location" | grep -m1 '\.sh$')" ]]; then
# If there are no `*.zsh` files either, we look for and source any
# `*.sh` files instead.
for script ($location/*.sh(N)) source "$script"
fi
# Add to $fpath, for completion(s).
fpath=($location $fpath)
fi
}
antigen-cleanup () {
# Cleanup unused repositories.
local force=false
if [[ $1 == --force ]]; then
force=true
fi
if [[ ! -d "$ADOTDIR/repos" || -z "$(ls "$ADOTDIR/repos/")" ]]; then
echo "You don't have any bundles."
return 0
fi
# Find directores in ADOTDIR/repos, that are not in the bundles record.
local unused_clones="$(comm -13 \
<(-antigen-echo-record \
| awk '$4 == "true" {print $1}' \
| while read line; do
-antigen-get-clone-dir "$line"
done \
| sort -u) \
<(ls -d "$ADOTDIR/repos/"* | sort -u))"
if [[ -z $unused_clones ]]; then
echo "You don't have any unidentified bundles."
return 0
fi
echo 'You have clones for the following repos, but are not used.'
echo "$unused_clones" \
| while read line; do
-antigen-get-clone-url "$line"
done \
| sed -e 's/^/ /' -e 's/|/, branch /'
if $force || (echo -n '\nDelete them all? [y/N] '; read -q); then
echo
echo
echo "$unused_clones" | while read line; do
echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..."
rm -rf "$line"
echo ' done.'
done
else
echo
echo Nothing deleted.
fi
}
antigen-lib () {
antigen-bundle --loc=lib
}
antigen-theme () {
local name="${1:-robbyrussell}"
antigen-bundle --loc=themes/$name.zsh-theme --btype=theme
}
antigen-apply () {
# Initialize completion.
# TODO: Only load completions if there are any changes to the bundle
# repositories.
compinit -i
}
antigen-list () {
# List all currently installed bundles
if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then
echo "You don't have any bundles." >&2
return 1
else
-antigen-echo-record | sort -u
fi
}
antigen-help () {
cat <<EOF
Antigen is a plugin management system for zsh. It makes it easy to grab awesome
shell scripts and utilities, put up on github. For further details and complete
documentation, visit the project's page at 'http://antigen.sharats.me'.
EOF
}
# A syntax sugar to avoid the `-` when calling antigen commands. With this
# function, you can write `antigen-bundle` as `antigen bundle` and so on.
antigen () {
local cmd="$1"
shift
"antigen-$cmd" "$@"
}
# Echo the bundle specs as in the record. The first line is not echoed since it
# is a blank line.
-antigen-echo-record () {
echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p'
}
-antigen-env-setup () {
# Pre-startup initializations
-set-default ANTIGEN_DEFAULT_REPO_URL \
https://github.com/robbyrussell/oh-my-zsh.git
-set-default ADOTDIR $HOME/.antigen
# Load the compinit module
autoload -U compinit
# Without the following, `compdef` function is not defined.
compinit -i
}
# Same as `export $1=$2`, but will only happen if the name specified by `$1` is
# not already set.
-set-default () {
local arg_name="$1"
local arg_value="$2"
eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'"
}
-antigen-env-setup