Blame view

antigen.zsh 10.1 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.
a12d3140a   Shrikant Sharat   Removed bundle-in...
5
  # <repo-url>, <plugin-location>, <bundle-type>
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
22
  
      # Set spec values based on the positional arguments.
3635aa19e   Shrikant Sharat   Refactoring to pr...
23
24
      local position_args
      position_args=(url loc)
e5dfac7ea   Shrikant Sharat   Initial commit. W...
25
26
      local i=1
      while ! [[ -z $1 || $1 == --*=* ]]; do
3635aa19e   Shrikant Sharat   Refactoring to pr...
27
          local arg_name="${position_args[$i]}"
43bb2cef1   Shrikant Sharat   Variable declarat...
28
          local arg_value="$1"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
29
30
31
32
33
34
35
          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.
4dceca485   Shrikant Sharat   Add support for b...
36
      while [[ $1 == --* ]]; do
ec9febf8c   Shrikant Sharat   Fix themes not be...
37
38
          # Remove the `--` at the start.
          local arg="${1#--}"
4dceca485   Shrikant Sharat   Add support for b...
39
40
41
42
  
          if [[ $arg != *=* ]]; then
              arg="$arg=true"
          fi
ec9febf8c   Shrikant Sharat   Fix themes not be...
43
44
45
46
          # Get the name of the arg and replace the `-`'s to `_`'s.
          local arg_name="${${arg%\=*}//-/_}"
  
          # Get the value of the arg.
4dceca485   Shrikant Sharat   Add support for b...
47
          local arg_value="${arg#*\=}"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
48
49
50
          eval "local $arg_name='$arg_value'"
          shift
      done
b29510ce7   Shrikant Sharat   Small code reorga...
51
52
53
54
55
      # 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...
56
      # Resolve the url.
39379a878   Shrikant Sharat   Move url resolvin...
57
      url="$(-antigen-resolve-bundle-url "$url")"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
58

2923c490c   Shrikant Sharat   Branch informatio...
59
60
61
62
      # Add the branch information to the url.
      if [[ ! -z $branch ]]; then
          url="$url|$branch"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
63
      # Add it to the record.
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
64
65
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD
  $url $loc $btype $no_local_clone"
a12d3140a   Shrikant Sharat   Removed bundle-in...
66

38b0b0409   Shrikant Sharat   Fix #12. Local bu...
67
68
69
70
      # Ensure a clone exists for this repo, if needed.
      if ! [[ $url == /* && $no_local_clone == true ]]; then
          -antigen-ensure-repo "$url"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
71

499c0dd5d   Shrikant Sharat   Added some comments.
72
      # Load the plugin.
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
73
      -antigen-load "$url" "$loc" "$btype" "$no_local_clone"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
74

a12d3140a   Shrikant Sharat   Removed bundle-in...
75
  }
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
76

39379a878   Shrikant Sharat   Move url resolvin...
77
78
79
80
81
  -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"
1cae4fc91   Shrikant Sharat   Some refactoring ...
82
      # Expand short github url syntax: `username/reponame`
60fa053ec   Shrikant Sharat   Add tests for url...
83
84
85
86
87
      if [[ $url != git://* && \
              $url != https://* && \
              $url != /* && \
              $url != git@github.com:*/*
              ]]; then
1cae4fc91   Shrikant Sharat   Some refactoring ...
88
          url="https://github.com/${url%.git}.git"
39379a878   Shrikant Sharat   Move url resolvin...
89
90
91
92
      fi
  
      echo "$url"
  }
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
93
94
95
96
97
98
  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...
99
      grep -v '^\s*$\|^#' | while read line; do
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
100
101
102
103
104
          # 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...
105
  antigen-update () {
158407151   Shrikant Sharat   Refactoring of pr...
106
      # Update your bundles, i.e., `git pull` in all the plugin repos.
8d0d219d6   Shrikant Sharat   Fix #9 Update com...
107
      -antigen-echo-record \
2923c490c   Shrikant Sharat   Branch informatio...
108
          | awk '{print $1}' \
8d0d219d6   Shrikant Sharat   Fix #9 Update com...
109
          | sort -u \
2923c490c   Shrikant Sharat   Branch informatio...
110
          | while read url; do
5d199ab20   Shrikant Sharat   Print the repo ur...
111
              echo "**** Pulling $url"
0912ba472   Shrikant Sharat   Print a summary o...
112
              -antigen-ensure-repo --update --verbose "$url"
5d199ab20   Shrikant Sharat   Print the repo ur...
113
              echo
8d0d219d6   Shrikant Sharat   Fix #9 Update com...
114
          done
158407151   Shrikant Sharat   Refactoring of pr...
115
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
116
  -antigen-get-clone-dir () {
a12d3140a   Shrikant Sharat   Removed bundle-in...
117
118
119
      # Takes a repo url and gives out the path that this url needs to be cloned
      # to. Doesn't actually clone anything.
      # TODO: Memoize?
843297b20   Shrikant Sharat   Initial implement...
120

2923c490c   Shrikant Sharat   Branch informatio...
121
122
      # The url given.
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
123

499c0dd5d   Shrikant Sharat   Added some comments.
124
125
      # Echo the full path to the clone directory.
      echo -n $ADOTDIR/repos/
2923c490c   Shrikant Sharat   Branch informatio...
126
      echo "$url" | sed \
a12d3140a   Shrikant Sharat   Removed bundle-in...
127
          -e 's./.-SLASH-.g' \
843297b20   Shrikant Sharat   Initial implement...
128
129
          -e 's.:.-COLON-.g' \
          -e 's.|.-PIPE-.g'
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
130
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
131
  -antigen-get-clone-url () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
132
133
134
135
136
      # 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/::" \
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.
499c0dd5d   Shrikant Sharat   Added some comments.
147
      # Check if we have to update.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
148
      local update=false
c1479baff   Shrikant Sharat   Accept a --verbos...
149
150
151
152
153
154
      # Verbose output.
      local verbose=false
  
      # Load any boolean arguments specified.
      while [[ $1 == --* ]]; do
          eval "local '${1#--}=true'"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
155
          shift
c1479baff   Shrikant Sharat   Accept a --verbos...
156
      done
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
157

499c0dd5d   Shrikant Sharat   Added some comments.
158
      # Get the clone's directory as per the given repo url and branch.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
159
      local url="$1"
2923c490c   Shrikant Sharat   Branch informatio...
160
      local clone_dir="$(-antigen-get-clone-dir $url)"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
161

499c0dd5d   Shrikant Sharat   Added some comments.
162
      # Clone if it doesn't already exist.
aa510273d   Shrikant Sharat   Removed useless l...
163
      if [[ ! -d $clone_dir ]]; then
2923c490c   Shrikant Sharat   Branch informatio...
164
          git clone "${url%|*}" "$clone_dir"
aa510273d   Shrikant Sharat   Removed useless l...
165
      elif $update; then
0912ba472   Shrikant Sharat   Print a summary o...
166
167
168
          # Save current revision.
          old_rev="$(git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
              rev-parse HEAD)"
499c0dd5d   Shrikant Sharat   Added some comments.
169
          # Pull changes if update requested.
0912ba472   Shrikant Sharat   Print a summary o...
170
171
172
173
174
          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)"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
175
      fi
499c0dd5d   Shrikant Sharat   Added some comments.
176
      # If its a specific branch that we want, checkout that branch.
2923c490c   Shrikant Sharat   Branch informatio...
177
      if [[ $url == *\|* ]]; then
843297b20   Shrikant Sharat   Initial implement...
178
          git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
2923c490c   Shrikant Sharat   Branch informatio...
179
              checkout "${url#*|}"
843297b20   Shrikant Sharat   Initial implement...
180
      fi
0912ba472   Shrikant Sharat   Print a summary o...
181
182
183
184
185
186
187
      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
e5dfac7ea   Shrikant Sharat   Initial commit. W...
188
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
189
  -antigen-load () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
190

a12d3140a   Shrikant Sharat   Removed bundle-in...
191
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
192
      local loc="$2"
a12d3140a   Shrikant Sharat   Removed bundle-in...
193
      local btype="$3"
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
194
      local no_local_clone="$4"
843297b20   Shrikant Sharat   Initial implement...
195

499c0dd5d   Shrikant Sharat   Added some comments.
196
      # The full location where the plugin is located.
38b0b0409   Shrikant Sharat   Fix #12. Local bu...
197
198
199
200
201
202
      local location
      if ! [[ $url == /* && $no_local_clone == true ]]; then
          location="$(-antigen-get-clone-dir "$url")/$loc"
      else
          location="$url"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
203

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

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

d535ba468   Shrikant Sharat   Introduced a new ...
210
      else
e5dfac7ea   Shrikant Sharat   Initial commit. W...
211

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

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

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

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

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

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

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

1f541f429   Shrikant Sharat   Add --force argum...
272
273
      if $force || (echo -n '
  Delete them all? [y/N] '; read -q); then
0b32bec27   Shrikant Sharat   bundle-cleanup co...
274
275
          echo
          echo
759e381e1   Shrikant Sharat   Refactor variable...
276
          echo "$unused_clones" | while read line; do
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
277
278
              echo -n "Deleting clone for $(-antigen-get-clone-url "$line")..."
              rm -rf "$line"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
279
280
281
282
283
284
285
              echo ' done.'
          done
      else
          echo
          echo Nothing deleted.
      fi
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
286
287
  antigen-lib () {
      antigen-bundle --loc=lib
e5dfac7ea   Shrikant Sharat   Initial commit. W...
288
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
289
  antigen-theme () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
290
      local name="${1:-robbyrussell}"
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
291
      antigen-bundle --loc=themes/$name.zsh-theme --btype=theme
e5dfac7ea   Shrikant Sharat   Initial commit. W...
292
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
293
  antigen-apply () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
294
      # Initialize completion.
a91386310   Shrikant Sharat   Add a todo note o...
295
296
      # TODO: Only load completions if there are any changes to the bundle
      # repositories.
e5dfac7ea   Shrikant Sharat   Initial commit. W...
297
298
      compinit -i
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
299
  antigen-list () {
df942673b   Shrikant Sharat   Added bundle-list...
300
      # List all currently installed bundles
9dc631003   Shrikant Sharat   Rename bundle rec...
301
      if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then
df942673b   Shrikant Sharat   Added bundle-list...
302
303
304
          echo "You don't have any bundles." >&2
          return 1
      else
3aa0d2d8a   Shrikant Sharat   Fix duplicate ent...
305
          -antigen-echo-record | sort -u
df942673b   Shrikant Sharat   Added bundle-list...
306
307
      fi
  }
fee42de18   Shrikant Sharat   Add a small antig...
308
309
310
311
312
313
314
  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...
315
316
317
318
319
320
321
  # 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" "$@"
  }
bc9d20c7a   Shrikant Sharat   Add comments.
322
323
  # 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...
324
  -antigen-echo-record () {
9dc631003   Shrikant Sharat   Rename bundle rec...
325
      echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p'
e5dfac7ea   Shrikant Sharat   Initial commit. W...
326
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
327
  -antigen-env-setup () {
3047bfeb7   Shrikant Sharat   Load compinit at ...
328
      # Pre-startup initializations
e5dfac7ea   Shrikant Sharat   Initial commit. W...
329
330
      -set-default ANTIGEN_DEFAULT_REPO_URL \
          https://github.com/robbyrussell/oh-my-zsh.git
911cc8cb5   Shrikant Sharat   Use ADOTDIR as th...
331
      -set-default ADOTDIR $HOME/.antigen
3047bfeb7   Shrikant Sharat   Load compinit at ...
332
333
334
335
336
337
  
      # Load the compinit module
      autoload -U compinit
  
      # Without the following, `compdef` function is not defined.
      compinit -i
e5dfac7ea   Shrikant Sharat   Initial commit. W...
338
339
340
341
342
  }
  
  # 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...
343
344
      local arg_name="$1"
      local arg_value="$2"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
345
346
      eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'"
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
347
  -antigen-env-setup