Blame view

antigen.zsh 15.3 KB
e5dfac7ea   Shrikant Sharat   Initial commit. W...
1
2
3
4
  #!/bin/zsh
  
  # Each line in this string has the following entries separated by a space
  # character.
c7827f8ac   Shrikant Sharat   Fix comments to i...
5
  # <repo-url>, <plugin-location>, <bundle-type>, <has-local-clone>
e5dfac7ea   Shrikant Sharat   Initial commit. W...
6
  # FIXME: Is not kept local by zsh!
9dc631003   Shrikant Sharat   Rename bundle rec...
7
  local _ANTIGEN_BUNDLE_RECORD=""
e5dfac7ea   Shrikant Sharat   Initial commit. W...
8
9
  
  # Syntaxes
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
10
  #   antigen-bundle <url> [<loc>=/]
843297b20   Shrikant Sharat   Initial implement...
11
12
  # Keyword only arguments:
  #   branch - The branch of the repo to use for this bundle.
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
13
  antigen-bundle () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
14
15
16
17
  
      # Bundle spec arguments' default values.
      local url="$ANTIGEN_DEFAULT_REPO_URL"
      local loc=/
2923c490c   Shrikant Sharat   Branch informatio...
18
      local branch=
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
19
      local no_local_clone=false
d535ba468   Shrikant Sharat   Introduced a new ...
20
      local btype=plugin
e5dfac7ea   Shrikant Sharat   Initial commit. W...
21

8bba7ab70   Shrikant Sharat   Use the new argum...
22
23
      # Parse the given arguments. (Will overwrite the above values).
      eval "$(-antigen-parse-args \
7a2ca5936   Shrikant Sharat   Allow whitespace ...
24
              'url?, loc? ; branch:?, no-local-clone?, btype:?' \
8bba7ab70   Shrikant Sharat   Use the new argum...
25
              "$@")"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
26

b29510ce7   Shrikant Sharat   Small code reorga...
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   Shrikant Sharat   Initial commit. W...
32
      # Resolve the url.
39379a878   Shrikant Sharat   Move url resolvin...
33
      url="$(-antigen-resolve-bundle-url "$url")"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
34

2923c490c   Shrikant Sharat   Branch informatio...
35
36
37
38
      # Add the branch information to the url.
      if [[ ! -z $branch ]]; then
          url="$url|$branch"
      fi
41abcf662   Shrikant Sharat   Simpler implement...
39
      # The `make_local_clone` variable better represents whether there should be
e6cc15b5f   Shrikant Sharat   Fix local paths w...
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   Shrikant Sharat   Simpler implement...
44
      local make_local_clone=true
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
45
46
      if [[ $url == /* && -z $branch &&
              ( $no_local_clone == true || ! -d $url/.git ) ]]; then
41abcf662   Shrikant Sharat   Simpler implement...
47
48
          make_local_clone=false
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
49
      # Add it to the record.
cbdabb20c   Shrikant Sharat   80|
50
51
52
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD
  $url $loc $btype"
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD $make_local_clone"
a12d3140a   Shrikant Sharat   Removed bundle-in...
53

38b0b0409   Shrikant Sharat   Fix #12. Local bu...
54
      # Ensure a clone exists for this repo, if needed.
41abcf662   Shrikant Sharat   Simpler implement...
55
      if $make_local_clone; then
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
56
57
          -antigen-ensure-repo "$url"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
58

499c0dd5d   Shrikant Sharat   Added some comments.
59
      # Load the plugin.
e6cc15b5f   Shrikant Sharat   Fix local paths w...
60
      -antigen-load "$url" "$loc" "$btype" "$make_local_clone"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
61

a12d3140a   Shrikant Sharat   Removed bundle-in...
62
  }
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
63

39379a878   Shrikant Sharat   Move url resolvin...
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   Shrikant Sharat   Minor comment edi...
69
      # Expand short github url syntax: `username/reponame`.
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
70
71
72
      if [[ $url != git://* &&
              $url != https://* &&
              $url != /* &&
60fa053ec   Shrikant Sharat   Add tests for url...
73
74
              $url != git@github.com:*/*
              ]]; then
1cae4fc91   Shrikant Sharat   Some refactoring ...
75
          url="https://github.com/${url%.git}.git"
39379a878   Shrikant Sharat   Move url resolvin...
76
77
78
79
      fi
  
      echo "$url"
  }
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
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   Shrikant Sharat   Fix #5. Ignore sp...
86
      grep -v '^\s*$\|^#' | while read line; do
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
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   Shrikant Sharat   Update README wit...
92
  antigen-update () {
158407151   Shrikant Sharat   Refactoring of pr...
93
      # Update your bundles, i.e., `git pull` in all the plugin repos.
d43f31a79   Shrikant Sharat   Initial implement...
94
95
  
      date > $ADOTDIR/revert-info
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
96
97
98
99
      -antigen-echo-record |
          awk '{print $1}' |
          sort -u |
          while read url; do
5d199ab20   Shrikant Sharat   Print the repo ur...
100
              echo "**** Pulling $url"
d43f31a79   Shrikant Sharat   Initial implement...
101
102
103
104
              (dir="$(-antigen-get-clone-dir "$url")"
                  echo -n "$dir:"
                  cd "$dir"
                  git rev-parse HEAD) >> $ADOTDIR/revert-info
723b284b4   Shrikant Sharat   Use the arg parsi...
105
              -antigen-ensure-repo "$url" --update --verbose
5d199ab20   Shrikant Sharat   Print the repo ur...
106
              echo
8d0d219d6   Shrikant Sharat   Fix #9 Update com...
107
          done
158407151   Shrikant Sharat   Refactoring of pr...
108
  }
d43f31a79   Shrikant Sharat   Initial implement...
109
110
111
112
113
114
115
116
117
118
119
120
121
122
  antigen-revert () {
      if ! [[ -f $ADOTDIR/revert-info ]]; then
          echo 'No revert information available. Cannot revert.' >&2
      fi
  
      cat $ADOTDIR/revert-info | sed '1!p' | while read line; do
          dir="$(echo "$line" | cut -d: -f1)"
          git --git-dir="$dir/.git" --work-tree="$dir" \
              checkout "$(echo "$line" | cut -d: -f2)" 2> /dev/null
      done
  
      echo "Reverted to state before running -update on $(
              cat $ADOTDIR/revert-info | sed -n 1p)."
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
123
  -antigen-get-clone-dir () {
a12d3140a   Shrikant Sharat   Removed bundle-in...
124
125
      # Takes a repo url and gives out the path that this url needs to be cloned
      # to. Doesn't actually clone anything.
499c0dd5d   Shrikant Sharat   Added some comments.
126
      echo -n $ADOTDIR/repos/
222271a0b   Shrikant Sharat   Memoization is no...
127
      echo "$1" | sed \
a12d3140a   Shrikant Sharat   Removed bundle-in...
128
          -e 's./.-SLASH-.g' \
843297b20   Shrikant Sharat   Initial implement...
129
130
          -e 's.:.-COLON-.g' \
          -e 's.|.-PIPE-.g'
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
131
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
132
  -antigen-get-clone-url () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
133
134
      # Takes a repo's clone dir and gives out the repo's original url that was
      # used to create the given directory path.
0b32bec27   Shrikant Sharat   bundle-cleanup co...
135
136
      echo "$1" | sed \
          -e "s:^$ADOTDIR/repos/::" \
0b32bec27   Shrikant Sharat   bundle-cleanup co...
137
          -e 's.-SLASH-./.g' \
843297b20   Shrikant Sharat   Initial implement...
138
          -e 's.-COLON-.:.g' \
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
139
          -e 's.-PIPE-.|.g'
0b32bec27   Shrikant Sharat   bundle-cleanup co...
140
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
141
  -antigen-ensure-repo () {
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
142

499c0dd5d   Shrikant Sharat   Added some comments.
143
144
145
      # 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   Shrikant Sharat   Accept a --verbos...
146
      # Argument defaults.
723b284b4   Shrikant Sharat   Use the arg parsi...
147
148
      # The url. No sane default for this, so just empty.
      local url=
499c0dd5d   Shrikant Sharat   Added some comments.
149
      # Check if we have to update.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
150
      local update=false
c1479baff   Shrikant Sharat   Accept a --verbos...
151
152
      # Verbose output.
      local verbose=false
723b284b4   Shrikant Sharat   Use the arg parsi...
153
154
      eval "$(-antigen-parse-args 'url ; update?, verbose?' "$@")"
      shift $#
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
155

499c0dd5d   Shrikant Sharat   Added some comments.
156
      # Get the clone's directory as per the given repo url and branch.
2923c490c   Shrikant Sharat   Branch informatio...
157
      local clone_dir="$(-antigen-get-clone-dir $url)"
062a7b830   Shrikant Sharat   Refactor temporar...
158
159
160
161
162
  
      # A temporary function wrapping the `git` command with repeated arguments.
      --plugin-git () {
          eval git --git-dir=$clone_dir/.git --work-tree=$clone_dir "$@"
      }
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
163

499c0dd5d   Shrikant Sharat   Added some comments.
164
      # Clone if it doesn't already exist.
aa510273d   Shrikant Sharat   Removed useless l...
165
      if [[ ! -d $clone_dir ]]; then
2923c490c   Shrikant Sharat   Branch informatio...
166
          git clone "${url%|*}" "$clone_dir"
aa510273d   Shrikant Sharat   Removed useless l...
167
      elif $update; then
0912ba472   Shrikant Sharat   Print a summary o...
168
          # Save current revision.
382d92096   Shrikant Sharat   Use local variabl...
169
          local old_rev="$(--plugin-git rev-parse HEAD)"
499c0dd5d   Shrikant Sharat   Added some comments.
170
          # Pull changes if update requested.
062a7b830   Shrikant Sharat   Refactor temporar...
171
          --plugin-git pull
0912ba472   Shrikant Sharat   Print a summary o...
172
          # Get the new revision.
382d92096   Shrikant Sharat   Use local variabl...
173
          local new_rev="$(--plugin-git rev-parse HEAD)"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
174
      fi
499c0dd5d   Shrikant Sharat   Added some comments.
175
      # If its a specific branch that we want, checkout that branch.
2923c490c   Shrikant Sharat   Branch informatio...
176
      if [[ $url == *\|* ]]; then
013216d53   Shrikant Sharat   Merge branch 'mas...
177
          local current_branch=${$(--plugin-git symbolic-ref HEAD)##refs/heads/}
ccc3d1443   Arash Rouhani   Stop saying "alre...
178
          local requested_branch="${url#*|}"
f783f3860   Shrikant Sharat   Comments and inde...
179
          # Only do the checkout when we are not already on the branch.
ccc3d1443   Arash Rouhani   Stop saying "alre...
180
          [[ $requested_branch != $current_branch ]] &&
f783f3860   Shrikant Sharat   Comments and inde...
181
              --plugin-git checkout $requested_branch
843297b20   Shrikant Sharat   Initial implement...
182
      fi
0912ba472   Shrikant Sharat   Print a summary o...
183
184
185
      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   Shrikant Sharat   Refactor temporar...
186
              --plugin-git log --oneline --reverse --no-merges --stat '@{1}..'
0912ba472   Shrikant Sharat   Print a summary o...
187
188
          fi
      fi
7af602dae   Shrikant Sharat   Minor comment edi...
189
      # Remove the temporary git wrapper function.
062a7b830   Shrikant Sharat   Refactor temporar...
190
      unfunction -- --plugin-git
e5dfac7ea   Shrikant Sharat   Initial commit. W...
191
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
192
  -antigen-load () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
193

a12d3140a   Shrikant Sharat   Removed bundle-in...
194
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
195
      local loc="$2"
a12d3140a   Shrikant Sharat   Removed bundle-in...
196
      local btype="$3"
41abcf662   Shrikant Sharat   Simpler implement...
197
      local make_local_clone="$4"
843297b20   Shrikant Sharat   Initial implement...
198

499c0dd5d   Shrikant Sharat   Added some comments.
199
      # The full location where the plugin is located.
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
200
      local location
41abcf662   Shrikant Sharat   Simpler implement...
201
      if $make_local_clone; then
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
202
203
204
205
          location="$(-antigen-get-clone-dir "$url")/$loc"
      else
          location="$url"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
206

d535ba468   Shrikant Sharat   Introduced a new ...
207
      if [[ $btype == theme ]]; then
e5dfac7ea   Shrikant Sharat   Initial commit. W...
208

d535ba468   Shrikant Sharat   Introduced a new ...
209
210
211
          # Of course, if its a theme, the location would point to the script
          # file.
          source "$location"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
212

d535ba468   Shrikant Sharat   Introduced a new ...
213
      else
e5dfac7ea   Shrikant Sharat   Initial commit. W...
214

7af602dae   Shrikant Sharat   Minor comment edi...
215
          # Source the plugin script.
d535ba468   Shrikant Sharat   Introduced a new ...
216
217
          # FIXME: I don't know. Looks very very ugly. Needs a better
          # implementation once tests are ready.
cd68a349f   Shrikant Sharat   Fix update to zsh...
218
          local script_loc="$(ls "$location" | grep -m1 '\.plugin\.zsh$')"
499c0dd5d   Shrikant Sharat   Added some comments.
219

d535ba468   Shrikant Sharat   Introduced a new ...
220
221
222
          if [[ -f $script_loc ]]; then
              # If we have a `*.plugin.zsh`, source it.
              source "$script_loc"
499c0dd5d   Shrikant Sharat   Added some comments.
223

cd68a349f   Shrikant Sharat   Fix update to zsh...
224
          elif [[ ! -z "$(ls "$location" | grep -m1 '\.zsh$')" ]]; then
d535ba468   Shrikant Sharat   Introduced a new ...
225
226
              # If there is no `*.plugin.zsh` file, source *all* the `*.zsh`
              # files.
cd68a349f   Shrikant Sharat   Fix update to zsh...
227
              for script ($location/*.zsh(N)) source "$script"
499c0dd5d   Shrikant Sharat   Added some comments.
228

cd68a349f   Shrikant Sharat   Fix update to zsh...
229
          elif [[ ! -z "$(ls "$location" | grep -m1 '\.sh$')" ]]; then
17f8e971e   Shrikant Sharat   Work with non zsh...
230
231
              # If there are no `*.zsh` files either, we look for and source any
              # `*.sh` files instead.
cd68a349f   Shrikant Sharat   Fix update to zsh...
232
              for script ($location/*.sh(N)) source "$script"
499c0dd5d   Shrikant Sharat   Added some comments.
233

d535ba468   Shrikant Sharat   Introduced a new ...
234
          fi
499c0dd5d   Shrikant Sharat   Added some comments.
235
          # Add to $fpath, for completion(s).
d535ba468   Shrikant Sharat   Introduced a new ...
236
237
238
          fpath=($location $fpath)
  
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
239

e5dfac7ea   Shrikant Sharat   Initial commit. W...
240
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
241
  antigen-cleanup () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
242

499c0dd5d   Shrikant Sharat   Added some comments.
243
      # Cleanup unused repositories.
1f541f429   Shrikant Sharat   Add --force argum...
244
245
246
247
      local force=false
      if [[ $1 == --force ]]; then
          force=true
      fi
0b32bec27   Shrikant Sharat   bundle-cleanup co...
248
249
250
251
252
253
254
      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   Shrikant Sharat   Get rid of backsl...
255
256
257
          <(-antigen-echo-record |
              awk '$4 == "true" {print $1}' |
              while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
258
                  -antigen-get-clone-dir "$line"
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
259
260
              done |
              sort -u) \
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
261
          <(ls -d "$ADOTDIR/repos/"* | sort -u))"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
262
263
264
265
266
267
268
  
      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   Shrikant Sharat   Get rid of backsl...
269
270
      echo "$unused_clones" |
          while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
271
              -antigen-get-clone-url "$line"
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
272
273
          done |
          sed -e 's/^/  /' -e 's/|/, branch /'
0b32bec27   Shrikant Sharat   bundle-cleanup co...
274

1f541f429   Shrikant Sharat   Add --force argum...
275
276
      if $force || (echo -n '
  Delete them all? [y/N] '; read -q); then
0b32bec27   Shrikant Sharat   bundle-cleanup co...
277
278
          echo
          echo
759e381e1   Shrikant Sharat   Refactor variable...
279
          echo "$unused_clones" | while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
280
281
              echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..."
              rm -rf "$line"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
282
283
284
285
286
287
288
              echo ' done.'
          done
      else
          echo
          echo Nothing deleted.
      fi
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
289
290
  antigen-lib () {
      antigen-bundle --loc=lib
e5dfac7ea   Shrikant Sharat   Initial commit. W...
291
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
292
  antigen-theme () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
293
      local name="${1:-robbyrussell}"
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
294
      antigen-bundle --loc=themes/$name.zsh-theme --btype=theme
e5dfac7ea   Shrikant Sharat   Initial commit. W...
295
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
296
  antigen-apply () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
297
      # Initialize completion.
a91386310   Shrikant Sharat   Add a todo note o...
298
299
      # TODO: Only load completions if there are any changes to the bundle
      # repositories.
e5dfac7ea   Shrikant Sharat   Initial commit. W...
300
301
      compinit -i
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
302
  antigen-list () {
7af602dae   Shrikant Sharat   Minor comment edi...
303
      # List all currently installed bundles.
9dc631003   Shrikant Sharat   Rename bundle rec...
304
      if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then
df942673b   Shrikant Sharat   Added bundle-list...
305
306
307
          echo "You don't have any bundles." >&2
          return 1
      else
3aa0d2d8a   Shrikant Sharat   Fix duplicate ent...
308
          -antigen-echo-record | sort -u
df942673b   Shrikant Sharat   Added bundle-list...
309
310
      fi
  }
fee42de18   Shrikant Sharat   Add a small antig...
311
312
313
314
315
316
317
  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   Shrikant Sharat   An `antigen` comm...
318
319
320
321
322
323
324
  # 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   Shrikant Sharat   Added function to...
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
  -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   Shrikant Sharat   Allow whitespace ...
352
      # Sanitize the spec
620c89d5b   Shrikant Sharat   Remove use of the...
353
354
      spec="$(echo "$spec" | tr '
  ' ' ' | sed 's/[[:space:]]//g')"
7a2ca5936   Shrikant Sharat   Allow whitespace ...
355

cffa56ed7   Shrikant Sharat   Added function to...
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
      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   Shrikant Sharat   Detect repeated a...
381
382
383
384
          if echo "$code" | grep -qm1 "^local $name="; then
              echo "Argument '$name' repeated with the value '$value'". >&2
              return
          fi
cffa56ed7   Shrikant Sharat   Added function to...
385
386
387
388
389
          --add-var $name "$value"
  
          shift
          i=$(($i + 1))
      done
973558eee   Shrikant Sharat   Support positiona...
390
      local keyword_args="$(
6d333dfa0   Shrikant Sharat   Fix #20. Using `s...
391
392
393
394
395
396
397
398
399
400
401
402
              # Positional arguments can double up as keyword arguments too.
              echo "$positional_args" | tr , '
  ' |
                  while read line; do
                      if [[ $line == *\? ]]; then
                          echo "${line%?}:?"
                      else
                          echo "$line:"
                      fi
                  done
  
              # Specified keyword arguments.
973558eee   Shrikant Sharat   Support positiona...
403
404
405
              echo "$spec" | cut -d\; -f2 | tr , '
  '
              )"
cffa56ed7   Shrikant Sharat   Added function to...
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
      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   Shrikant Sharat   Detect repeated a...
422
423
424
425
          if echo "$code" | grep -qm1 "^local $name="; then
              echo "Argument '$name' repeated with the value '$value'". >&2
              return
          fi
cffa56ed7   Shrikant Sharat   Added function to...
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
          # 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   Shrikant Sharat   Add comments.
460
461
  # Echo the bundle specs as in the record. The first line is not echoed since it
  # is a blank line.
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
462
  -antigen-echo-record () {
9dc631003   Shrikant Sharat   Rename bundle rec...
463
      echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p'
e5dfac7ea   Shrikant Sharat   Initial commit. W...
464
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
465
  -antigen-env-setup () {
7af602dae   Shrikant Sharat   Minor comment edi...
466
      # Pre-startup initializations.
e5dfac7ea   Shrikant Sharat   Initial commit. W...
467
468
      -set-default ANTIGEN_DEFAULT_REPO_URL \
          https://github.com/robbyrussell/oh-my-zsh.git
911cc8cb5   Shrikant Sharat   Use ADOTDIR as th...
469
      -set-default ADOTDIR $HOME/.antigen
3047bfeb7   Shrikant Sharat   Load compinit at ...
470

7af602dae   Shrikant Sharat   Minor comment edi...
471
      # Load the compinit module.
3047bfeb7   Shrikant Sharat   Load compinit at ...
472
473
474
475
      autoload -U compinit
  
      # Without the following, `compdef` function is not defined.
      compinit -i
e5dfac7ea   Shrikant Sharat   Initial commit. W...
476
477
478
479
480
  }
  
  # Same as `export $1=$2`, but will only happen if the name specified by `$1` is
  # not already set.
  -set-default () {
43bb2cef1   Shrikant Sharat   Variable declarat...
481
482
      local arg_name="$1"
      local arg_value="$2"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
483
484
      eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'"
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
485
  -antigen-env-setup