Blame view

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

2923c490c   Shrikant Sharat   Branch informatio...
56
57
58
59
      # Add the branch information to the url.
      if [[ ! -z $branch ]]; then
          url="$url|$branch"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
60
      # Add it to the record.
2923c490c   Shrikant Sharat   Branch informatio...
61
62
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD
  $url $loc $btype"
a12d3140a   Shrikant Sharat   Removed bundle-in...
63

499c0dd5d   Shrikant Sharat   Added some comments.
64
      # Ensure a clone exists for this repo.
2923c490c   Shrikant Sharat   Branch informatio...
65
      -antigen-ensure-repo "$url"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
66

499c0dd5d   Shrikant Sharat   Added some comments.
67
      # Load the plugin.
2923c490c   Shrikant Sharat   Branch informatio...
68
      -antigen-load "$url" "$loc" "$btype"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
69

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

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

2923c490c   Shrikant Sharat   Branch informatio...
116
117
      # The url given.
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
118

499c0dd5d   Shrikant Sharat   Added some comments.
119
120
      # Echo the full path to the clone directory.
      echo -n $ADOTDIR/repos/
2923c490c   Shrikant Sharat   Branch informatio...
121
      echo "$url" | sed \
a12d3140a   Shrikant Sharat   Removed bundle-in...
122
          -e 's./.-SLASH-.g' \
843297b20   Shrikant Sharat   Initial implement...
123
124
          -e 's.:.-COLON-.g' \
          -e 's.|.-PIPE-.g'
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
125
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
126
  -antigen-get-clone-url () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
127
128
129
130
131
      # 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...
132
          -e 's.-SLASH-./.g' \
843297b20   Shrikant Sharat   Initial implement...
133
          -e 's.-COLON-.:.g' \
a5e21a6a1   Shrikant Sharat   Do comparisons wi...
134
          -e 's.-PIPE-.|.g'
0b32bec27   Shrikant Sharat   bundle-cleanup co...
135
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
136
  -antigen-ensure-repo () {
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
137

499c0dd5d   Shrikant Sharat   Added some comments.
138
139
140
      # 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...
141
      # Argument defaults.
499c0dd5d   Shrikant Sharat   Added some comments.
142
      # Check if we have to update.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
143
      local update=false
c1479baff   Shrikant Sharat   Accept a --verbos...
144
145
146
147
148
149
      # Verbose output.
      local verbose=false
  
      # Load any boolean arguments specified.
      while [[ $1 == --* ]]; do
          eval "local '${1#--}=true'"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
150
          shift
c1479baff   Shrikant Sharat   Accept a --verbos...
151
      done
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
152

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

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

a12d3140a   Shrikant Sharat   Removed bundle-in...
186
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
187
      local loc="$2"
a12d3140a   Shrikant Sharat   Removed bundle-in...
188
      local btype="$3"
843297b20   Shrikant Sharat   Initial implement...
189

499c0dd5d   Shrikant Sharat   Added some comments.
190
      # The full location where the plugin is located.
2923c490c   Shrikant Sharat   Branch informatio...
191
      local location="$(-antigen-get-clone-dir "$url")/$loc"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
192

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

d535ba468   Shrikant Sharat   Introduced a new ...
195
196
197
          # Of course, if its a theme, the location would point to the script
          # file.
          source "$location"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
198

d535ba468   Shrikant Sharat   Introduced a new ...
199
      else
e5dfac7ea   Shrikant Sharat   Initial commit. W...
200

d535ba468   Shrikant Sharat   Introduced a new ...
201
202
203
          # 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...
204
          local script_loc="$(ls "$location" | grep -m1 '\.plugin\.zsh$')"
499c0dd5d   Shrikant Sharat   Added some comments.
205

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

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

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

d535ba468   Shrikant Sharat   Introduced a new ...
220
          fi
499c0dd5d   Shrikant Sharat   Added some comments.
221
          # Add to $fpath, for completion(s).
d535ba468   Shrikant Sharat   Introduced a new ...
222
223
224
          fpath=($location $fpath)
  
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
225

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

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

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