Blame view

antigen.zsh 21.2 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=""
23ddf4336   Shrikant Sharat   Code formatting.
8
  local _ANTIGEN_INSTALL_DIR="$(cd "$(dirname "$0")" && pwd)"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
9

5e23ab6fe   Will Boyce   Defer `compdef` c...
10
11
  # Used to defer compinit/compdef
  typeset -a __deferred_compdefs
a9ebdcdbe   Shrikant Sharat   Don't load compin...
12
  compdef () { __deferred_compdefs=($__deferred_compdefs "$*") }
5e23ab6fe   Will Boyce   Defer `compdef` c...
13

e5dfac7ea   Shrikant Sharat   Initial commit. W...
14
  # Syntaxes
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
15
  #   antigen-bundle <url> [<loc>=/]
843297b20   Shrikant Sharat   Initial implement...
16
17
  # Keyword only arguments:
  #   branch - The branch of the repo to use for this bundle.
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
18
  antigen-bundle () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
19
20
21
22
  
      # Bundle spec arguments' default values.
      local url="$ANTIGEN_DEFAULT_REPO_URL"
      local loc=/
2923c490c   Shrikant Sharat   Branch informatio...
23
      local branch=
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
24
      local no_local_clone=false
d535ba468   Shrikant Sharat   Introduced a new ...
25
      local btype=plugin
e5dfac7ea   Shrikant Sharat   Initial commit. W...
26

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

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

2923c490c   Shrikant Sharat   Branch informatio...
40
41
42
43
      # Add the branch information to the url.
      if [[ ! -z $branch ]]; then
          url="$url|$branch"
      fi
41abcf662   Shrikant Sharat   Simpler implement...
44
      # The `make_local_clone` variable better represents whether there should be
e6cc15b5f   Shrikant Sharat   Fix local paths w...
45
46
47
48
      # 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...
49
      local make_local_clone=true
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
50
51
      if [[ $url == /* && -z $branch &&
              ( $no_local_clone == true || ! -d $url/.git ) ]]; then
41abcf662   Shrikant Sharat   Simpler implement...
52
53
          make_local_clone=false
      fi
0c257ebe4   Shrikant Sharat   For #29. Intial w...
54
55
56
57
      # Add the theme extension to `loc`, if this is a theme.
      if [[ $btype == theme && $loc != *.zsh-theme ]]; then
          loc="$loc.zsh-theme"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
58
      # Add it to the record.
cbdabb20c   Shrikant Sharat   80|
59
60
61
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD
  $url $loc $btype"
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD $make_local_clone"
a12d3140a   Shrikant Sharat   Removed bundle-in...
62

38b0b0409   Shrikant Sharat   Fix #12. Local bu...
63
      # Ensure a clone exists for this repo, if needed.
41abcf662   Shrikant Sharat   Simpler implement...
64
      if $make_local_clone; then
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
65
66
          -antigen-ensure-repo "$url"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
67

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

a12d3140a   Shrikant Sharat   Removed bundle-in...
71
  }
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
72

39379a878   Shrikant Sharat   Move url resolvin...
73
74
75
76
77
  -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...
78
      # Expand short github url syntax: `username/reponame`.
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
79
80
81
      if [[ $url != git://* &&
              $url != https://* &&
              $url != /* &&
60fa053ec   Shrikant Sharat   Add tests for url...
82
83
              $url != git@github.com:*/*
              ]]; then
1cae4fc91   Shrikant Sharat   Some refactoring ...
84
          url="https://github.com/${url%.git}.git"
39379a878   Shrikant Sharat   Move url resolvin...
85
86
87
88
      fi
  
      echo "$url"
  }
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
89
90
91
92
93
94
  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
7c351dd3f   Shrikant Sharat   Fix line filterin...
95
      grep '^[[:space:]]*[^[:space:]#]' | while read line; do
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
96
97
98
99
100
          # 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...
101
  antigen-update () {
158407151   Shrikant Sharat   Refactoring of pr...
102
      # Update your bundles, i.e., `git pull` in all the plugin repos.
d43f31a79   Shrikant Sharat   Initial implement...
103
104
  
      date > $ADOTDIR/revert-info
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
105
      -antigen-echo-record |
fdcb458fd   Shrikant Sharat   Update messes plu...
106
          awk '$4 == "true" {print $1}' |
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
107
108
          sort -u |
          while read url; do
5d199ab20   Shrikant Sharat   Print the repo ur...
109
              echo "**** Pulling $url"
fdcb458fd   Shrikant Sharat   Update messes plu...
110
111
112
113
114
115
116
  
              local clone_dir="$(-antigen-get-clone-dir "$url")"
              if [[ -d "$clone_dir" ]]; then
                  (echo -n "$clone_dir:"
                      cd "$clone_dir"
                      git rev-parse HEAD) >> $ADOTDIR/revert-info
              fi
723b284b4   Shrikant Sharat   Use the arg parsi...
117
              -antigen-ensure-repo "$url" --update --verbose
fdcb458fd   Shrikant Sharat   Update messes plu...
118

5d199ab20   Shrikant Sharat   Print the repo ur...
119
              echo
8d0d219d6   Shrikant Sharat   Fix #9 Update com...
120
          done
158407151   Shrikant Sharat   Refactoring of pr...
121
  }
d43f31a79   Shrikant Sharat   Initial implement...
122
  antigen-revert () {
56ae2d04d   Mark Feltner   Modified some con...
123
124
125
126
127
128
129
130
131
132
133
134
      if [[ -f $ADOTDIR/revert-info ]]; then
          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)."
  
      else 
d43f31a79   Shrikant Sharat   Initial implement...
135
136
          echo 'No revert information available. Cannot revert.' >&2
      fi
d43f31a79   Shrikant Sharat   Initial implement...
137

d43f31a79   Shrikant Sharat   Initial implement...
138
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
139
  -antigen-get-clone-dir () {
a12d3140a   Shrikant Sharat   Removed bundle-in...
140
141
      # 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.
142
      echo -n $ADOTDIR/repos/
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
143
144
145
  
      if [[ "$1" == "https://github.com/sorin-ionescu/prezto.git" ]]; then
          # Prezto's directory *has* to be `.zprezto`.
297f0f733   Shrikant Sharat   The `-n` in url/d...
146
          echo .zprezto
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
147

c0ee02666   Hugaerts@gmail.com   add support for p...
148
      else
297f0f733   Shrikant Sharat   The `-n` in url/d...
149
          echo "$1" | sed \
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
150
151
152
              -e 's./.-SLASH-.g' \
              -e 's.:.-COLON-.g' \
              -e 's.|.-PIPE-.g'
c0ee02666   Hugaerts@gmail.com   add support for p...
153
      fi
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
154
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
155
  -antigen-get-clone-url () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
156
157
      # Takes a repo's clone dir and gives out the repo's original url that was
      # used to create the given directory path.
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
158
159
160
161
  
      if [[ "$1" == ".zprezto" ]]; then
          # Prezto's (in `.zprezto`), is assumed to be from `sorin-ionescu`'s
          # remote.
297f0f733   Shrikant Sharat   The `-n` in url/d...
162
          echo https://github.com/sorin-ionescu/prezto.git
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
163

c0ee02666   Hugaerts@gmail.com   add support for p...
164
      else
297f0f733   Shrikant Sharat   The `-n` in url/d...
165
          echo "$1" | sed \
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
166
167
168
169
              -e "s:^$ADOTDIR/repos/::" \
              -e 's.-SLASH-./.g' \
              -e 's.-COLON-.:.g' \
              -e 's.-PIPE-.|.g'
c0ee02666   Hugaerts@gmail.com   add support for p...
170
      fi
0b32bec27   Shrikant Sharat   bundle-cleanup co...
171
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
172
  -antigen-ensure-repo () {
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
173

499c0dd5d   Shrikant Sharat   Added some comments.
174
175
176
      # 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...
177
      # Argument defaults.
723b284b4   Shrikant Sharat   Use the arg parsi...
178
179
      # The url. No sane default for this, so just empty.
      local url=
499c0dd5d   Shrikant Sharat   Added some comments.
180
      # Check if we have to update.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
181
      local update=false
c1479baff   Shrikant Sharat   Accept a --verbos...
182
183
      # Verbose output.
      local verbose=false
723b284b4   Shrikant Sharat   Use the arg parsi...
184
185
      eval "$(-antigen-parse-args 'url ; update?, verbose?' "$@")"
      shift $#
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
186

499c0dd5d   Shrikant Sharat   Added some comments.
187
      # Get the clone's directory as per the given repo url and branch.
2923c490c   Shrikant Sharat   Branch informatio...
188
      local clone_dir="$(-antigen-get-clone-dir $url)"
062a7b830   Shrikant Sharat   Refactor temporar...
189
190
191
  
      # A temporary function wrapping the `git` command with repeated arguments.
      --plugin-git () {
3c16e1f03   Shrikant Sharat   Avoid git cd-less...
192
          (cd "$clone_dir" && git --no-pager "$@")
062a7b830   Shrikant Sharat   Refactor temporar...
193
      }
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
194

499c0dd5d   Shrikant Sharat   Added some comments.
195
      # Clone if it doesn't already exist.
aa510273d   Shrikant Sharat   Removed useless l...
196
      if [[ ! -d $clone_dir ]]; then
2873acbf1   Gregory Hugaerts   make bundles inst...
197
          git clone --recursive "${url%|*}" "$clone_dir"
aa510273d   Shrikant Sharat   Removed useless l...
198
      elif $update; then
0912ba472   Shrikant Sharat   Print a summary o...
199
          # Save current revision.
382d92096   Shrikant Sharat   Use local variabl...
200
          local old_rev="$(--plugin-git rev-parse HEAD)"
499c0dd5d   Shrikant Sharat   Added some comments.
201
          # Pull changes if update requested.
3c16e1f03   Shrikant Sharat   Avoid git cd-less...
202
          --plugin-git pull
292d226b9   Shrikant Sharat   Use `--plugin-git...
203
          # Update submodules.
3c16e1f03   Shrikant Sharat   Avoid git cd-less...
204
          --plugin-git submodule update --recursive
0912ba472   Shrikant Sharat   Print a summary o...
205
          # Get the new revision.
382d92096   Shrikant Sharat   Use local variabl...
206
          local new_rev="$(--plugin-git rev-parse HEAD)"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
207
      fi
499c0dd5d   Shrikant Sharat   Added some comments.
208
      # If its a specific branch that we want, checkout that branch.
2923c490c   Shrikant Sharat   Branch informatio...
209
      if [[ $url == *\|* ]]; then
013216d53   Shrikant Sharat   Merge branch 'mas...
210
          local current_branch=${$(--plugin-git symbolic-ref HEAD)##refs/heads/}
ccc3d1443   Arash Rouhani   Stop saying "alre...
211
          local requested_branch="${url#*|}"
f783f3860   Shrikant Sharat   Comments and inde...
212
          # Only do the checkout when we are not already on the branch.
ccc3d1443   Arash Rouhani   Stop saying "alre...
213
          [[ $requested_branch != $current_branch ]] &&
f783f3860   Shrikant Sharat   Comments and inde...
214
              --plugin-git checkout $requested_branch
843297b20   Shrikant Sharat   Initial implement...
215
      fi
56ae2d04d   Mark Feltner   Modified some con...
216
      if [[ -n $old_rev && $old_rev != $new_rev ]]; then
0912ba472   Shrikant Sharat   Print a summary o...
217
218
          echo Updated from ${old_rev:0:7} to ${new_rev:0:7}.
          if $verbose; then
062a7b830   Shrikant Sharat   Refactor temporar...
219
              --plugin-git log --oneline --reverse --no-merges --stat '@{1}..'
0912ba472   Shrikant Sharat   Print a summary o...
220
221
          fi
      fi
7af602dae   Shrikant Sharat   Minor comment edi...
222
      # Remove the temporary git wrapper function.
062a7b830   Shrikant Sharat   Refactor temporar...
223
      unfunction -- --plugin-git
e5dfac7ea   Shrikant Sharat   Initial commit. W...
224
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
225
  -antigen-load () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
226

a12d3140a   Shrikant Sharat   Removed bundle-in...
227
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
228
      local loc="$2"
a12d3140a   Shrikant Sharat   Removed bundle-in...
229
      local btype="$3"
41abcf662   Shrikant Sharat   Simpler implement...
230
      local make_local_clone="$4"
843297b20   Shrikant Sharat   Initial implement...
231

499c0dd5d   Shrikant Sharat   Added some comments.
232
      # The full location where the plugin is located.
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
233
      local location
41abcf662   Shrikant Sharat   Simpler implement...
234
      if $make_local_clone; then
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
235
236
237
238
          location="$(-antigen-get-clone-dir "$url")/$loc"
      else
          location="$url"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
239

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

d535ba468   Shrikant Sharat   Introduced a new ...
242
243
244
          # Of course, if its a theme, the location would point to the script
          # file.
          source "$location"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
245

d535ba468   Shrikant Sharat   Introduced a new ...
246
      else
e5dfac7ea   Shrikant Sharat   Initial commit. W...
247

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

286957967   Ryuta Kamizono   Fix `*.plugin.zsh...
253
          if [[ -f $location/$script_loc ]]; then
d535ba468   Shrikant Sharat   Introduced a new ...
254
              # If we have a `*.plugin.zsh`, source it.
286957967   Ryuta Kamizono   Fix `*.plugin.zsh...
255
              source "$location/$script_loc"
eb1ebaf3c   Shrikant Sharat   Load `init.zsh` i...
256
257
  
          elif [[ -f $location/init.zsh ]]; then
b84ae117e   Gregory Hugaerts   add check for pmo...
258
259
              # If we have a `init.zsh`
              if (( $+functions[pmodload] )); then
a58d8cf02   Shrikant Sharat   Simplify loading ...
260
261
262
                  # If pmodload is defined pmodload the module. Remove `modules/`
                  # from loc to find module name.
                  pmodload "${loc#modules/}"
b84ae117e   Gregory Hugaerts   add check for pmo...
263
              else
a58d8cf02   Shrikant Sharat   Simplify loading ...
264
                  # Otherwise source it.
b84ae117e   Gregory Hugaerts   add check for pmo...
265
266
                  source "$location/init.zsh"
              fi
499c0dd5d   Shrikant Sharat   Added some comments.
267

d1d1c538f   Shrikant Sharat   Mild refactoring.
268
          elif ls "$location" | grep -qm1 '\.zsh$'; then
d535ba468   Shrikant Sharat   Introduced a new ...
269
270
              # If there is no `*.plugin.zsh` file, source *all* the `*.zsh`
              # files.
cd68a349f   Shrikant Sharat   Fix update to zsh...
271
              for script ($location/*.zsh(N)) source "$script"
499c0dd5d   Shrikant Sharat   Added some comments.
272

d1d1c538f   Shrikant Sharat   Mild refactoring.
273
          elif ls "$location" | grep -qm1 '\.sh$'; then
17f8e971e   Shrikant Sharat   Work with non zsh...
274
275
              # If there are no `*.zsh` files either, we look for and source any
              # `*.sh` files instead.
cd68a349f   Shrikant Sharat   Fix update to zsh...
276
              for script ($location/*.sh(N)) source "$script"
499c0dd5d   Shrikant Sharat   Added some comments.
277

d535ba468   Shrikant Sharat   Introduced a new ...
278
          fi
499c0dd5d   Shrikant Sharat   Added some comments.
279
          # Add to $fpath, for completion(s).
d535ba468   Shrikant Sharat   Introduced a new ...
280
281
282
          fpath=($location $fpath)
  
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
283

e5dfac7ea   Shrikant Sharat   Initial commit. W...
284
  }
a54264963   Shrikant Sharat   Refactorings on t...
285
286
287
  # Update (with `git pull`) antigen itself.
  # TODO: Once update is finished, show a summary of the new commits, as a kind of
  # "what's new" message.
a6d46893a   Xavier Garrido   add a selfupdate ...
288
  antigen-selfupdate () {
a54264963   Shrikant Sharat   Refactorings on t...
289
290
291
292
      ( cd $_ANTIGEN_INSTALL_DIR
          if [[ ! -d .git ]]; then
              echo "Your copy of antigen doesn't appear to be a git clone. " \
                  "The 'selfupdate' command cannot work in this case."
a6d46893a   Xavier Garrido   add a selfupdate ...
293
294
295
296
297
              return 1
          fi
          git pull
      )
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
298
  antigen-cleanup () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
299

499c0dd5d   Shrikant Sharat   Added some comments.
300
      # Cleanup unused repositories.
1f541f429   Shrikant Sharat   Add --force argum...
301
302
303
304
      local force=false
      if [[ $1 == --force ]]; then
          force=true
      fi
0b32bec27   Shrikant Sharat   bundle-cleanup co...
305
306
307
308
309
310
311
      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...
312
313
314
          <(-antigen-echo-record |
              awk '$4 == "true" {print $1}' |
              while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
315
                  -antigen-get-clone-dir "$line"
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
316
317
              done |
              sort -u) \
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
318
          <(ls -d "$ADOTDIR/repos/"* | sort -u))"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
319
320
321
322
323
324
325
  
      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...
326
327
      echo "$unused_clones" |
          while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
328
              -antigen-get-clone-url "$line"
0b4fbaaf6   Shrikant Sharat   Get rid of backsl...
329
330
          done |
          sed -e 's/^/  /' -e 's/|/, branch /'
0b32bec27   Shrikant Sharat   bundle-cleanup co...
331

1f541f429   Shrikant Sharat   Add --force argum...
332
333
      if $force || (echo -n '
  Delete them all? [y/N] '; read -q); then
0b32bec27   Shrikant Sharat   bundle-cleanup co...
334
335
          echo
          echo
759e381e1   Shrikant Sharat   Refactor variable...
336
          echo "$unused_clones" | while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
337
338
              echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..."
              rm -rf "$line"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
339
340
341
342
343
344
345
              echo ' done.'
          done
      else
          echo
          echo Nothing deleted.
      fi
  }
da678afb2   Adam Stankiewicz   Introduce antigen...
346
  antigen-use () {
2b0796f6a   Shrikant Sharat   Add a `Usage:` li...
347
      if [[ $1 == oh-my-zsh ]]; then
387fbc4d4   Shrikant Sharat   Internalize libra...
348
          -antigen-use-oh-my-zsh
2b0796f6a   Shrikant Sharat   Add a `Usage:` li...
349
      elif [[ $1 == prezto ]]; then
387fbc4d4   Shrikant Sharat   Internalize libra...
350
          -antigen-use-prezto
da678afb2   Adam Stankiewicz   Introduce antigen...
351
      else
2b0796f6a   Shrikant Sharat   Add a `Usage:` li...
352
353
          echo 'Usage: antigen-use <library-name>' >&2
          echo 'Where <library-name> is any one of the following:' >&2
da678afb2   Adam Stankiewicz   Introduce antigen...
354
355
356
357
358
          echo ' * oh-my-zsh' >&2
          echo ' * prezto' >&2
          return 1
      fi
  }
387fbc4d4   Shrikant Sharat   Internalize libra...
359
  -antigen-use-oh-my-zsh () {
c3198e0aa   Shrikant Sharat   Set `$ZSH` to oh-...
360
361
362
      if [[ -z "$ZSH" ]]; then
          export ZSH="$(-antigen-get-clone-dir "$ANTIGEN_DEFAULT_REPO_URL")"
      fi
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
363
      antigen-bundle --loc=lib
e5dfac7ea   Shrikant Sharat   Initial commit. W...
364
  }
387fbc4d4   Shrikant Sharat   Internalize libra...
365
  -antigen-use-prezto () {
c0ee02666   Hugaerts@gmail.com   add support for p...
366
367
368
      antigen-bundle sorin-ionescu/prezto
      export ZDOTDIR=$ADOTDIR/repos/
  }
387fbc4d4   Shrikant Sharat   Internalize libra...
369
  # For backwards compatibility.
ff5f83bb8   Shrikant Sharat   80|
370
371
372
373
374
375
376
377
378
379
380
381
  antigen-lib () {
      -antigen-use-oh-my-zsh
      echo '`antigen-lib` is deprecated and will soon be removed.'
      echo 'Use `antigen-use oh-my-zsh` instead.'
  }
  
  # For backwards compatibility.
  antigen-prezto-lib () {
      -antigen-use-prezto
      echo '`antigen-prezto-lib` is deprecated and will soon be removed.'
      echo 'Use `antigen-use prezto` instead.'
  }
387fbc4d4   Shrikant Sharat   Internalize libra...
382

a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
383
  antigen-theme () {
0c257ebe4   Shrikant Sharat   For #29. Intial w...
384
385
386
387
388
389
390
391
392
393
394
  
      if [[ "$1" != */* && "$1" != --* ]]; then
          # The first argument is just a name of the plugin, to be picked up from
          # the default repo.
          local name="${1:-robbyrussell}"
          antigen-bundle --loc=themes/$name --btype=theme
  
      else
          antigen-bundle "$@" --btype=theme
  
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
395
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
396
  antigen-apply () {
a9ebdcdbe   Shrikant Sharat   Don't load compin...
397

e5dfac7ea   Shrikant Sharat   Initial commit. W...
398
      # Initialize completion.
a9ebdcdbe   Shrikant Sharat   Don't load compin...
399
400
401
402
403
404
405
406
407
408
409
      local cdef
  
      # Load the compinit module. This will readefine the `compdef` function to
      # the one that actually initializes completions.
      autoload -U compinit
      compinit -i
  
      # Apply all `compinit`s that have been deferred.
      eval "$(for cdef in $__deferred_compdefs; do
                  echo compdef $cdef
              done)"
5e23ab6fe   Will Boyce   Defer `compdef` c...
410
      unset __deferred_compdefs
a9ebdcdbe   Shrikant Sharat   Don't load compin...
411

e5dfac7ea   Shrikant Sharat   Initial commit. W...
412
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
413
  antigen-list () {
7af602dae   Shrikant Sharat   Minor comment edi...
414
      # List all currently installed bundles.
9dc631003   Shrikant Sharat   Rename bundle rec...
415
      if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then
df942673b   Shrikant Sharat   Added bundle-list...
416
417
418
          echo "You don't have any bundles." >&2
          return 1
      else
3aa0d2d8a   Shrikant Sharat   Fix duplicate ent...
419
          -antigen-echo-record | sort -u
df942673b   Shrikant Sharat   Added bundle-list...
420
421
      fi
  }
d36c6f93d   Shrikant Sharat   Implemented `anti...
422
423
424
425
426
427
428
  antigen-snapshot () {
  
      local snapshot_file="${1:-antigen-shapshot}"
  
      # The snapshot content lines are pairs of repo-url and git version hash, in
      # the form:
      #   <version-hash> <repo-url>
5b8e33407   Shrikant Sharat   Only save bundles...
429
430
431
432
      local snapshot_content="$(-antigen-echo-record |
          grep 'true$' |
          sed 's/ .*$//' |
          sort -u |
d36c6f93d   Shrikant Sharat   Implemented `anti...
433
          while read url; do
2c2f91c92   Shrikant Sharat   Added `antigen-re...
434
435
436
              local dir="$(-antigen-get-clone-dir "$url")"
              local version_hash="$(cd "$dir" && git rev-parse HEAD)"
              echo "$version_hash $url"
d36c6f93d   Shrikant Sharat   Implemented `anti...
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
          done)"
  
      {
          # The first line in the snapshot file is for metadata, in the form:
          #   key='value'; key='value'; key='value';
          # Where `key`s are valid shell variable names.
  
          # Snapshot version. Has no relation to antigen version. If the snapshot
          # file format changes, this number can be incremented.
          echo -n "version='1';"
  
          # Snapshot creation date+time.
          echo -n " created_on='$(date)';"
  
          # Add a checksum with the md5 checksum of all the snapshot lines.
          local checksum="$(echo "$snapshot_content" | md5sum)"
          echo -n " checksum='${checksum%% *}';"
  
          # A newline after the metadata and then the snapshot lines.
          echo "
  $snapshot_content"
  
      } > "$snapshot_file"
  
  }
2c2f91c92   Shrikant Sharat   Added `antigen-re...
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
  antigen-restore () {
  
      if [[ $# == 0 ]]; then
          echo 'Please provide a snapshot file to restore from.' >&2
          return 1
      fi
  
      local snapshot_file="$1"
  
      # TODO: Before doing anything with the snapshot file, verify its checksum.
      # If it fails, notify this to the user and confirm if restore should
      # proceed.
  
      echo -n "Restoring from $snapshot_file..."
  
      sed -n '1!p' "$snapshot_file" |
          while read line; do
  
              local version_hash="${line%% *}"
              local url="${line##* }"
              local clone_dir="$(-antigen-get-clone-dir "$url")"
  
              if [[ ! -d $clone_dir ]]; then
                  git clone "$url" "$clone_dir" > /dev/null
              fi
  
              (cd "$clone_dir" && git checkout $version_hash) 2> /dev/null
  
          done
  
      echo ' done.'
      echo 'Please open a new shell to get the restored changes.'
  }
fee42de18   Shrikant Sharat   Add a small antig...
495
496
497
498
499
500
501
  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...
502
503
504
505
  # 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"
876b7ae4f   Shrikant Sharat   Return with error...
506
507
508
509
510
      if [[ -z "$cmd" ]]; then
          echo 'Please give a command to run.' >&2
          return 1
      fi
      shift
426eb0789   rummik   Add some error ch...
511
512
513
514
  
      if functions "antigen-$cmd" > /dev/null; then
          "antigen-$cmd" "$@"
      else
876b7ae4f   Shrikant Sharat   Return with error...
515
          echo "Unknown command: $cmd"
426eb0789   rummik   Add some error ch...
516
      fi
fd547d958   Shrikant Sharat   An `antigen` comm...
517
  }
cffa56ed7   Shrikant Sharat   Added function to...
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
  -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 ...
545
      # Sanitize the spec
620c89d5b   Shrikant Sharat   Remove use of the...
546
547
      spec="$(echo "$spec" | tr '
  ' ' ' | sed 's/[[:space:]]//g')"
7a2ca5936   Shrikant Sharat   Allow whitespace ...
548

cffa56ed7   Shrikant Sharat   Added function to...
549
550
551
552
553
554
555
556
557
558
559
560
561
562
      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
56ae2d04d   Mark Feltner   Modified some con...
563
      while [[ -n $1 && $1 != --* ]]; do
cffa56ed7   Shrikant Sharat   Added function to...
564
565
566
567
568
569
570
571
572
573
  
          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...
574
575
576
577
          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...
578
579
580
581
582
          --add-var $name "$value"
  
          shift
          i=$(($i + 1))
      done
973558eee   Shrikant Sharat   Support positiona...
583
      local keyword_args="$(
6d333dfa0   Shrikant Sharat   Fix #20. Using `s...
584
585
586
587
588
589
590
591
592
593
594
595
              # 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...
596
597
598
              echo "$spec" | cut -d\; -f2 | tr , '
  '
              )"
cffa56ed7   Shrikant Sharat   Added function to...
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
      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...
615
616
617
618
          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...
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
          # 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.
653
654
  # 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...
655
  -antigen-echo-record () {
9dc631003   Shrikant Sharat   Rename bundle rec...
656
      echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p'
e5dfac7ea   Shrikant Sharat   Initial commit. W...
657
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
658
  -antigen-env-setup () {
3e9253968   Shrikant Sharat   Moved `-set-defau...
659
660
661
662
663
664
665
666
  
      # Helper function: 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'"
      }
7af602dae   Shrikant Sharat   Minor comment edi...
667
      # Pre-startup initializations.
e5dfac7ea   Shrikant Sharat   Initial commit. W...
668
669
      -set-default ANTIGEN_DEFAULT_REPO_URL \
          https://github.com/robbyrussell/oh-my-zsh.git
911cc8cb5   Shrikant Sharat   Use ADOTDIR as th...
670
      -set-default ADOTDIR $HOME/.antigen
3047bfeb7   Shrikant Sharat   Load compinit at ...
671

37b9bb1e4   Shrikant Sharat   Rollback #36. com...
672
673
      # Setup antigen's own completion.
      compdef _antigen antigen
e5dfac7ea   Shrikant Sharat   Initial commit. W...
674

3e9253968   Shrikant Sharat   Moved `-set-defau...
675
676
      # Remove private functions.
      unfunction -- -set-default
e5dfac7ea   Shrikant Sharat   Initial commit. W...
677
  }
84c855441   Guilherme Espada   Half-fix #26
678
  # Setup antigen's autocompletion
b69ad8866   Shrikant Sharat   Fix code formatti...
679
  _antigen () {
a6d46893a   Xavier Garrido   add a selfupdate ...
680
681
682
683
684
685
686
687
688
689
690
      compadd        \
          bundle     \
          bundles    \
          update     \
          revert     \
          list       \
          cleanup    \
          lib        \
          selfupdate \
          theme      \
          apply      \
b69ad8866   Shrikant Sharat   Fix code formatti...
691
          help
84c855441   Guilherme Espada   Half-fix #26
692
  }
b69ad8866   Shrikant Sharat   Fix code formatti...
693
  -antigen-env-setup