Blame view
antigen.zsh
14.3 KB
|
e5dfac7ea
|
1 2 3 4 |
#!/bin/zsh # Each line in this string has the following entries separated by a space # character. |
|
c7827f8ac
|
5 |
# <repo-url>, <plugin-location>, <bundle-type>, <has-local-clone> |
|
e5dfac7ea
|
6 |
# FIXME: Is not kept local by zsh! |
|
9dc631003
|
7 |
local _ANTIGEN_BUNDLE_RECORD="" |
|
e5dfac7ea
|
8 9 |
# Syntaxes |
|
a4f6e2fc8
|
10 |
# antigen-bundle <url> [<loc>=/] |
|
843297b20
|
11 12 |
# Keyword only arguments: # branch - The branch of the repo to use for this bundle. |
|
a4f6e2fc8
|
13 |
antigen-bundle () {
|
|
e5dfac7ea
|
14 15 16 17 |
# Bundle spec arguments' default values.
local url="$ANTIGEN_DEFAULT_REPO_URL"
local loc=/
|
|
2923c490c
|
18 |
local branch= |
|
38b0b0409
|
19 |
local no_local_clone=false |
|
d535ba468
|
20 |
local btype=plugin |
|
e5dfac7ea
|
21 |
|
|
8bba7ab70
|
22 23 |
# Parse the given arguments. (Will overwrite the above values).
eval "$(-antigen-parse-args \
|
|
7a2ca5936
|
24 |
'url?, loc? ; branch:?, no-local-clone?, btype:?' \ |
|
8bba7ab70
|
25 |
"$@")" |
|
e5dfac7ea
|
26 |
|
|
b29510ce7
|
27 28 29 30 31 |
# Check if url is just the plugin name. Super short syntax.
if [[ "$url" != */* ]]; then
loc="plugins/$url"
url="$ANTIGEN_DEFAULT_REPO_URL"
fi
|
|
e5dfac7ea
|
32 |
# Resolve the url. |
|
39379a878
|
33 |
url="$(-antigen-resolve-bundle-url "$url")" |
|
e5dfac7ea
|
34 |
|
|
2923c490c
|
35 36 37 38 |
# Add the branch information to the url.
if [[ ! -z $branch ]]; then
url="$url|$branch"
fi
|
|
41abcf662
|
39 |
# The `make_local_clone` variable better represents whether there should be |
|
e6cc15b5f
|
40 41 42 43 |
# 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.
|
|
41abcf662
|
44 |
local make_local_clone=true |
|
0b4fbaaf6
|
45 46 |
if [[ $url == /* && -z $branch &&
( $no_local_clone == true || ! -d $url/.git ) ]]; then
|
|
41abcf662
|
47 48 |
make_local_clone=false
fi
|
|
e5dfac7ea
|
49 |
# Add it to the record. |
|
cbdabb20c
|
50 51 52 |
_ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD
$url $loc $btype"
_ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD $make_local_clone"
|
|
a12d3140a
|
53 |
|
|
38b0b0409
|
54 |
# Ensure a clone exists for this repo, if needed. |
|
41abcf662
|
55 |
if $make_local_clone; then |
|
38b0b0409
|
56 57 |
-antigen-ensure-repo "$url"
fi
|
|
e5dfac7ea
|
58 |
|
|
499c0dd5d
|
59 |
# Load the plugin. |
|
e6cc15b5f
|
60 |
-antigen-load "$url" "$loc" "$btype" "$make_local_clone" |
|
2ac7c0cb0
|
61 |
|
|
a12d3140a
|
62 |
} |
|
2ac7c0cb0
|
63 |
|
|
39379a878
|
64 65 66 67 68 |
-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"
|
|
7af602dae
|
69 |
# Expand short github url syntax: `username/reponame`. |
|
0b4fbaaf6
|
70 71 72 |
if [[ $url != git://* &&
$url != https://* &&
$url != /* &&
|
|
60fa053ec
|
73 74 |
$url != git@github.com:*/*
]]; then
|
|
1cae4fc91
|
75 |
url="https://github.com/${url%.git}.git"
|
|
39379a878
|
76 77 78 79 |
fi
echo "$url"
}
|
|
3c5ff1c1e
|
80 81 82 83 84 85 |
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
|
|
2e6d0c416
|
86 |
grep -v '^\s*$\|^#' | while read line; do |
|
3c5ff1c1e
|
87 88 89 90 91 |
# Using `eval` so that we can use the shell-style quoting in each line
# piped to `antigen-bundles`.
eval "antigen-bundle $line"
done
}
|
|
2fe4683b3
|
92 |
antigen-update () {
|
|
158407151
|
93 |
# Update your bundles, i.e., `git pull` in all the plugin repos. |
|
0b4fbaaf6
|
94 95 96 97 |
-antigen-echo-record |
awk '{print $1}' |
sort -u |
while read url; do
|
|
5d199ab20
|
98 |
echo "**** Pulling $url" |
|
723b284b4
|
99 |
-antigen-ensure-repo "$url" --update --verbose |
|
5d199ab20
|
100 |
echo |
|
8d0d219d6
|
101 |
done |
|
158407151
|
102 |
} |
|
a4f6e2fc8
|
103 |
-antigen-get-clone-dir () {
|
|
a12d3140a
|
104 105 |
# Takes a repo url and gives out the path that this url needs to be cloned
# to. Doesn't actually clone anything.
|
|
499c0dd5d
|
106 |
echo -n $ADOTDIR/repos/ |
|
222271a0b
|
107 |
echo "$1" | sed \ |
|
a12d3140a
|
108 |
-e 's./.-SLASH-.g' \ |
|
843297b20
|
109 110 |
-e 's.:.-COLON-.g' \
-e 's.|.-PIPE-.g'
|
|
2ac7c0cb0
|
111 |
} |
|
a4f6e2fc8
|
112 |
-antigen-get-clone-url () {
|
|
0b32bec27
|
113 114 |
# Takes a repo's clone dir and gives out the repo's original url that was
# used to create the given directory path.
|
|
0b32bec27
|
115 116 |
echo "$1" | sed \
-e "s:^$ADOTDIR/repos/::" \
|
|
0b32bec27
|
117 |
-e 's.-SLASH-./.g' \ |
|
843297b20
|
118 |
-e 's.-COLON-.:.g' \ |
|
a5e21a6a1
|
119 |
-e 's.-PIPE-.|.g' |
|
0b32bec27
|
120 |
} |
|
a4f6e2fc8
|
121 |
-antigen-ensure-repo () {
|
|
2ac7c0cb0
|
122 |
|
|
499c0dd5d
|
123 124 125 |
# 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.
|
|
c1479baff
|
126 |
# Argument defaults. |
|
723b284b4
|
127 128 |
# The url. No sane default for this, so just empty.
local url=
|
|
499c0dd5d
|
129 |
# Check if we have to update. |
|
2ac7c0cb0
|
130 |
local update=false |
|
c1479baff
|
131 132 |
# Verbose output.
local verbose=false
|
|
723b284b4
|
133 134 |
eval "$(-antigen-parse-args 'url ; update?, verbose?' "$@")"
shift $#
|
|
2ac7c0cb0
|
135 |
|
|
499c0dd5d
|
136 |
# Get the clone's directory as per the given repo url and branch. |
|
2923c490c
|
137 |
local clone_dir="$(-antigen-get-clone-dir $url)" |
|
062a7b830
|
138 139 140 141 142 |
# A temporary function wrapping the `git` command with repeated arguments.
--plugin-git () {
eval git --git-dir=$clone_dir/.git --work-tree=$clone_dir "$@"
}
|
|
2ac7c0cb0
|
143 |
|
|
499c0dd5d
|
144 |
# Clone if it doesn't already exist. |
|
aa510273d
|
145 |
if [[ ! -d $clone_dir ]]; then |
|
2923c490c
|
146 |
git clone "${url%|*}" "$clone_dir"
|
|
aa510273d
|
147 |
elif $update; then |
|
0912ba472
|
148 |
# Save current revision. |
|
382d92096
|
149 |
local old_rev="$(--plugin-git rev-parse HEAD)" |
|
499c0dd5d
|
150 |
# Pull changes if update requested. |
|
062a7b830
|
151 |
--plugin-git pull |
|
0912ba472
|
152 |
# Get the new revision. |
|
382d92096
|
153 |
local new_rev="$(--plugin-git rev-parse HEAD)" |
|
2ac7c0cb0
|
154 |
fi |
|
499c0dd5d
|
155 |
# If its a specific branch that we want, checkout that branch. |
|
2923c490c
|
156 |
if [[ $url == *\|* ]]; then |
|
013216d53
|
157 |
local current_branch=${$(--plugin-git symbolic-ref HEAD)##refs/heads/}
|
|
ccc3d1443
|
158 |
local requested_branch="${url#*|}"
|
|
f783f3860
|
159 |
# Only do the checkout when we are not already on the branch. |
|
ccc3d1443
|
160 |
[[ $requested_branch != $current_branch ]] && |
|
f783f3860
|
161 |
--plugin-git checkout $requested_branch |
|
843297b20
|
162 |
fi |
|
0912ba472
|
163 164 165 |
if ! [[ -z $old_rev || $old_rev == $new_rev ]]; then
echo Updated from ${old_rev:0:7} to ${new_rev:0:7}.
if $verbose; then
|
|
062a7b830
|
166 |
--plugin-git log --oneline --reverse --no-merges --stat '@{1}..'
|
|
0912ba472
|
167 168 |
fi
fi
|
|
7af602dae
|
169 |
# Remove the temporary git wrapper function. |
|
062a7b830
|
170 |
unfunction -- --plugin-git |
|
e5dfac7ea
|
171 |
} |
|
a4f6e2fc8
|
172 |
-antigen-load () {
|
|
e5dfac7ea
|
173 |
|
|
a12d3140a
|
174 |
local url="$1" |
|
843297b20
|
175 |
local loc="$2" |
|
a12d3140a
|
176 |
local btype="$3" |
|
41abcf662
|
177 |
local make_local_clone="$4" |
|
843297b20
|
178 |
|
|
499c0dd5d
|
179 |
# The full location where the plugin is located. |
|
38b0b0409
|
180 |
local location |
|
41abcf662
|
181 |
if $make_local_clone; then |
|
38b0b0409
|
182 183 184 185 |
location="$(-antigen-get-clone-dir "$url")/$loc"
else
location="$url"
fi
|
|
e5dfac7ea
|
186 |
|
|
d535ba468
|
187 |
if [[ $btype == theme ]]; then |
|
e5dfac7ea
|
188 |
|
|
d535ba468
|
189 190 191 |
# Of course, if its a theme, the location would point to the script
# file.
source "$location"
|
|
e5dfac7ea
|
192 |
|
|
d535ba468
|
193 |
else |
|
e5dfac7ea
|
194 |
|
|
7af602dae
|
195 |
# Source the plugin script. |
|
d535ba468
|
196 197 |
# FIXME: I don't know. Looks very very ugly. Needs a better
# implementation once tests are ready.
|
|
cd68a349f
|
198 |
local script_loc="$(ls "$location" | grep -m1 '\.plugin\.zsh$')" |
|
499c0dd5d
|
199 |
|
|
d535ba468
|
200 201 202 |
if [[ -f $script_loc ]]; then
# If we have a `*.plugin.zsh`, source it.
source "$script_loc"
|
|
499c0dd5d
|
203 |
|
|
cd68a349f
|
204 |
elif [[ ! -z "$(ls "$location" | grep -m1 '\.zsh$')" ]]; then |
|
d535ba468
|
205 206 |
# If there is no `*.plugin.zsh` file, source *all* the `*.zsh`
# files.
|
|
cd68a349f
|
207 |
for script ($location/*.zsh(N)) source "$script" |
|
499c0dd5d
|
208 |
|
|
cd68a349f
|
209 |
elif [[ ! -z "$(ls "$location" | grep -m1 '\.sh$')" ]]; then |
|
17f8e971e
|
210 211 |
# If there are no `*.zsh` files either, we look for and source any
# `*.sh` files instead.
|
|
cd68a349f
|
212 |
for script ($location/*.sh(N)) source "$script" |
|
499c0dd5d
|
213 |
|
|
d535ba468
|
214 |
fi |
|
499c0dd5d
|
215 |
# Add to $fpath, for completion(s). |
|
d535ba468
|
216 217 218 |
fpath=($location $fpath)
fi
|
|
e5dfac7ea
|
219 |
|
|
e5dfac7ea
|
220 |
} |
|
a4f6e2fc8
|
221 |
antigen-cleanup () {
|
|
0b32bec27
|
222 |
|
|
499c0dd5d
|
223 |
# Cleanup unused repositories. |
|
1f541f429
|
224 225 226 227 |
local force=false
if [[ $1 == --force ]]; then
force=true
fi
|
|
0b32bec27
|
228 229 230 231 232 233 234 |
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 \
|
|
0b4fbaaf6
|
235 236 237 |
<(-antigen-echo-record |
awk '$4 == "true" {print $1}' |
while read line; do
|
|
a5e21a6a1
|
238 |
-antigen-get-clone-dir "$line" |
|
0b4fbaaf6
|
239 240 |
done |
sort -u) \
|
|
a5e21a6a1
|
241 |
<(ls -d "$ADOTDIR/repos/"* | sort -u))" |
|
0b32bec27
|
242 243 244 245 246 247 248 |
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.'
|
|
0b4fbaaf6
|
249 250 |
echo "$unused_clones" |
while read line; do
|
|
a5e21a6a1
|
251 |
-antigen-get-clone-url "$line" |
|
0b4fbaaf6
|
252 253 |
done |
sed -e 's/^/ /' -e 's/|/, branch /'
|
|
0b32bec27
|
254 |
|
|
1f541f429
|
255 256 |
if $force || (echo -n ' Delete them all? [y/N] '; read -q); then |
|
0b32bec27
|
257 258 |
echo
echo
|
|
759e381e1
|
259 |
echo "$unused_clones" | while read line; do |
|
a5e21a6a1
|
260 261 |
echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..."
rm -rf "$line"
|
|
0b32bec27
|
262 263 264 265 266 267 268 |
echo ' done.'
done
else
echo
echo Nothing deleted.
fi
}
|
|
a4f6e2fc8
|
269 270 |
antigen-lib () {
antigen-bundle --loc=lib
|
|
e5dfac7ea
|
271 |
} |
|
a4f6e2fc8
|
272 |
antigen-theme () {
|
|
e5dfac7ea
|
273 |
local name="${1:-robbyrussell}"
|
|
a4f6e2fc8
|
274 |
antigen-bundle --loc=themes/$name.zsh-theme --btype=theme |
|
e5dfac7ea
|
275 |
} |
|
a4f6e2fc8
|
276 |
antigen-apply () {
|
|
e5dfac7ea
|
277 |
# Initialize completion. |
|
a91386310
|
278 279 |
# TODO: Only load completions if there are any changes to the bundle
# repositories.
|
|
e5dfac7ea
|
280 281 |
compinit -i } |
|
a4f6e2fc8
|
282 |
antigen-list () {
|
|
7af602dae
|
283 |
# List all currently installed bundles. |
|
9dc631003
|
284 |
if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then |
|
df942673b
|
285 286 287 |
echo "You don't have any bundles." >&2
return 1
else
|
|
3aa0d2d8a
|
288 |
-antigen-echo-record | sort -u |
|
df942673b
|
289 290 |
fi } |
|
fee42de18
|
291 292 293 294 295 296 297 |
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
}
|
|
fd547d958
|
298 299 300 301 302 303 304 |
# 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" "$@"
}
|
|
cffa56ed7
|
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 |
-antigen-parse-args () {
# An argument parsing functionality to parse arguments the *antigen* way :).
# Takes one first argument (called spec), which dictates how to parse and
# the rest of the arguments are parsed. Outputs a piece of valid shell code
# that can be passed to `eval` inside a function which creates the arguments
# and their values as local variables. Suggested use is to set the defaults
# to all arguments first and then eval the output of this function.
# Spec: Only long argument supported. No support for parsing short options.
# The spec must have two sections, separated by a `;`.
# '<positional-arguments>;<keyword-only-arguments>'
# Positional arguments are passed as just values, like `command a b`.
# Keyword arguments are passed as a `--name=value` pair, like `command
# --arg1=a --arg2=b`.
# Each argument in the spec is separated by a `,`. Each keyword argument can
# end in a `:` to specifiy that this argument wants a value, otherwise it
# doesn't take a value. (The value in the output when the keyword argument
# doesn't have a `:` is `true`).
# Arguments in either section can end with a `?` (should come after `:`, if
# both are present), means optional. FIXME: Not yet implemented.
# See the test file, tests/arg-parser.t for (working) examples.
local spec="$1"
shift
|
|
7a2ca5936
|
332 333 334 |
# Sanitize the spec
spec="$(echo "$spec" | tr '
' ' ' | sed -r 's/\s+//g')"
|
|
cffa56ed7
|
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 |
local code=''
--add-var () {
test -z "$code" || code="$code
"
code="${code}local $1='$2'"
}
local positional_args="$(echo "$spec" | cut -d\; -f1)"
local positional_args_count="$(echo $positional_args |
awk -F, '{print NF}')"
# Set spec values based on the positional arguments.
local i=1
while ! [[ -z $1 || $1 == --* ]]; do
if (( $i > $positional_args_count )); then
echo "Only $positional_args_count positional arguments allowed." >&2
echo "Found at least one more: '$1'" >&2
return
fi
local name_spec="$(echo "$positional_args" | cut -d, -f$i)"
local name="${${name_spec%\?}%:}"
local value="$1"
|
|
9d1b71736
|
360 361 362 363 |
if echo "$code" | grep -qm1 "^local $name="; then
echo "Argument '$name' repeated with the value '$value'". >&2
return
fi
|
|
cffa56ed7
|
364 365 366 367 368 |
--add-var $name "$value"
shift
i=$(($i + 1))
done
|
|
973558eee
|
369 370 371 372 373 374 |
local keyword_args="$(
echo "$positional_args" | tr , '
' | sed -r 's/(\??)$/:\1/'
echo "$spec" | cut -d\; -f2 | tr , '
'
)"
|
|
cffa56ed7
|
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
local keyword_args_count="$(echo $keyword_args | awk -F, '{print NF}')"
# 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#--}"
# Get the argument name and value.
if [[ $arg != *=* ]]; then
local name="$arg"
local value=''
else
local name="${arg%\=*}"
local value="${arg#*=}"
fi
|
|
9d1b71736
|
391 392 393 394 |
if echo "$code" | grep -qm1 "^local $name="; then
echo "Argument '$name' repeated with the value '$value'". >&2
return
fi
|
|
cffa56ed7
|
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# The specification for this argument, used for validations.
local arg_line="$(echo "$keyword_args" | grep -m1 "^$name:\??\?")"
# Validate argument and value.
if [[ -z $arg_line ]]; then
# This argument is not known to us.
echo "Unknown argument '$name'." >&2
return
elif (echo "$arg_line" | grep -qm1 ':') && [[ -z $value ]]; then
# This argument needs a value, but is not provided.
echo "Required argument for '$name' not provided." >&2
return
elif (echo "$arg_line" | grep -vqm1 ':') && [[ ! -z $value ]]; then
# This argument doesn't need a value, but is provided.
echo "No argument required for '$name', but provided '$value'." >&2
return
fi
if [[ -z $value ]]; then
value=true
fi
--add-var "${name//-/_}" "$value"
shift
done
echo "$code"
unfunction -- --add-var
}
|
|
bc9d20c7a
|
429 430 |
# Echo the bundle specs as in the record. The first line is not echoed since it # is a blank line. |
|
a4f6e2fc8
|
431 |
-antigen-echo-record () {
|
|
9dc631003
|
432 |
echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p' |
|
e5dfac7ea
|
433 |
} |
|
a4f6e2fc8
|
434 |
-antigen-env-setup () {
|
|
7af602dae
|
435 |
# Pre-startup initializations. |
|
e5dfac7ea
|
436 437 |
-set-default ANTIGEN_DEFAULT_REPO_URL \
https://github.com/robbyrussell/oh-my-zsh.git
|
|
911cc8cb5
|
438 |
-set-default ADOTDIR $HOME/.antigen |
|
3047bfeb7
|
439 |
|
|
7af602dae
|
440 |
# Load the compinit module. |
|
3047bfeb7
|
441 442 443 444 |
autoload -U compinit
# Without the following, `compdef` function is not defined.
compinit -i
|
|
e5dfac7ea
|
445 446 447 448 449 |
}
# Same as `export $1=$2`, but will only happen if the name specified by `$1` is
# not already set.
-set-default () {
|
|
43bb2cef1
|
450 451 |
local arg_name="$1"
local arg_value="$2"
|
|
e5dfac7ea
|
452 453 |
eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'" } |
|
a4f6e2fc8
|
454 |
-antigen-env-setup |