Blame view

antigen.zsh 9.02 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=/
843297b20   Shrikant Sharat   Initial implement...
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.
280ec4481   Shrikant Sharat   name argument for...
22
      local position_args='url loc'
e5dfac7ea   Shrikant Sharat   Initial commit. W...
23
24
      local i=1
      while ! [[ -z $1 || $1 == --*=* ]]; do
43bb2cef1   Shrikant Sharat   Variable declarat...
25
26
          local arg_name="$(echo "$position_args" | cut -d\  -f$i)"
          local arg_value="$1"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
27
28
29
30
          eval "local $arg_name='$arg_value'"
          shift
          i=$(($i + 1))
      done
1abf1faf6   Shrikant Sharat   Plugins can be sp...
31
32
33
34
35
      # 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...
36
37
38
      # Set spec values from keyword arguments, if any. The remaining arguments
      # are all assumed to be keyword arguments.
      while [[ $1 == --*=* ]]; do
43bb2cef1   Shrikant Sharat   Variable declarat...
39
40
          local arg_name="$(echo "$1" | cut -d= -f1 | sed 's/^--//')"
          local arg_value="$(echo "$1" | cut -d= -f2)"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
41
42
43
44
45
          eval "local $arg_name='$arg_value'"
          shift
      done
  
      # Resolve the url.
39379a878   Shrikant Sharat   Move url resolvin...
46
      url="$(-antigen-resolve-bundle-url "$url")"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
47

e5dfac7ea   Shrikant Sharat   Initial commit. W...
48
      # Add it to the record.
843297b20   Shrikant Sharat   Initial implement...
49
50
      _ANTIGEN_BUNDLE_RECORD="$_ANTIGEN_BUNDLE_RECORD
  $url $loc $btype $branch"
a12d3140a   Shrikant Sharat   Removed bundle-in...
51

499c0dd5d   Shrikant Sharat   Added some comments.
52
      # Ensure a clone exists for this repo.
843297b20   Shrikant Sharat   Initial implement...
53
      -antigen-ensure-repo "$url" "$branch"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
54

499c0dd5d   Shrikant Sharat   Added some comments.
55
      # Load the plugin.
843297b20   Shrikant Sharat   Initial implement...
56
      -antigen-load "$url" "$loc" "$btype" "$branch"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
57

a12d3140a   Shrikant Sharat   Removed bundle-in...
58
  }
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
59

39379a878   Shrikant Sharat   Move url resolvin...
60
61
62
63
64
  -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"
60fa053ec   Shrikant Sharat   Add tests for url...
65
66
67
68
69
      if [[ $url != git://* && \
              $url != https://* && \
              $url != /* && \
              $url != git@github.com:*/*
              ]]; then
39379a878   Shrikant Sharat   Move url resolvin...
70
71
72
73
74
75
          url="${url%.git}"
          url="https://github.com/$url.git"
      fi
  
      echo "$url"
  }
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
76
77
78
79
80
81
  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...
82
      grep -v '^\s*$\|^#' | while read line; do
3c5ff1c1e   Shrikant Sharat   Add antigen-bundl...
83
84
85
86
87
          # 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...
88
  antigen-update () {
158407151   Shrikant Sharat   Refactoring of pr...
89
      # Update your bundles, i.e., `git pull` in all the plugin repos.
8d0d219d6   Shrikant Sharat   Fix #9 Update com...
90
91
92
93
94
95
      -antigen-echo-record \
          | awk '{print $1 "|" $4}' \
          | sort -u \
          | while read url_line; do
              -antigen-ensure-repo --update "${url_line%|*}" "${url_line#*|}"
          done
158407151   Shrikant Sharat   Refactoring of pr...
96
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
97
  -antigen-get-clone-dir () {
a12d3140a   Shrikant Sharat   Removed bundle-in...
98
99
100
      # 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...
101
102
      local url="$1"
      local branch="$2"
843297b20   Shrikant Sharat   Initial implement...
103

499c0dd5d   Shrikant Sharat   Added some comments.
104
105
      # The branched_url will be the same as the url itself, unless there is no
      # branch specified.
843297b20   Shrikant Sharat   Initial implement...
106
      local branched_url="$url"
499c0dd5d   Shrikant Sharat   Added some comments.
107
108
      # If a branch is specified, i.e., branch is not `-`, append it to the url,
      # separating with a pipe character.
843297b20   Shrikant Sharat   Initial implement...
109
110
111
      if [[ "$branch" != - ]]; then
          branched_url="$branched_url|$branch"
      fi
499c0dd5d   Shrikant Sharat   Added some comments.
112
113
      # Echo the full path to the clone directory.
      echo -n $ADOTDIR/repos/
843297b20   Shrikant Sharat   Initial implement...
114
      echo "$branched_url" | sed \
a12d3140a   Shrikant Sharat   Removed bundle-in...
115
116
          -e 's/\.git$//' \
          -e 's./.-SLASH-.g' \
843297b20   Shrikant Sharat   Initial implement...
117
118
          -e 's.:.-COLON-.g' \
          -e 's.|.-PIPE-.g'
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
119
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
120
  -antigen-get-clone-url () {
0b32bec27   Shrikant Sharat   bundle-cleanup co...
121
122
123
124
125
126
127
      # 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/::" \
          -e 's/$/.git/' \
          -e 's.-SLASH-./.g' \
843297b20   Shrikant Sharat   Initial implement...
128
129
          -e 's.-COLON-.:.g' \
          -e 's.-PIPE-.|.g'
0b32bec27   Shrikant Sharat   bundle-cleanup co...
130
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
131
  -antigen-ensure-repo () {
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
132

499c0dd5d   Shrikant Sharat   Added some comments.
133
134
135
136
137
      # 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.
  
      # Check if we have to update.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
138
139
140
141
142
      local update=false
      if [[ $1 == --update ]]; then
          update=true
          shift
      fi
499c0dd5d   Shrikant Sharat   Added some comments.
143
      # Get the clone's directory as per the given repo url and branch.
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
144
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
145
146
      local branch="$2"
      local clone_dir="$(-antigen-get-clone-dir $url $branch)"
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
147

499c0dd5d   Shrikant Sharat   Added some comments.
148
      # Clone if it doesn't already exist.
aa510273d   Shrikant Sharat   Removed useless l...
149
150
151
      if [[ ! -d $clone_dir ]]; then
          git clone "$url" "$clone_dir"
      elif $update; then
499c0dd5d   Shrikant Sharat   Added some comments.
152
          # Pull changes if update requested.
aa1012e7f   Shrikant Sharat   Fix #4. Updated f...
153
          git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" pull
2ac7c0cb0   Shrikant Sharat   Bundles are insta...
154
      fi
499c0dd5d   Shrikant Sharat   Added some comments.
155
      # If its a specific branch that we want, checkout that branch.
843297b20   Shrikant Sharat   Initial implement...
156
157
158
159
      if [[ "$branch" != - ]]; then
          git --git-dir "$clone_dir/.git" --work-tree "$clone_dir" \
              checkout "$branch"
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
160
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
161
  -antigen-load () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
162

a12d3140a   Shrikant Sharat   Removed bundle-in...
163
      local url="$1"
843297b20   Shrikant Sharat   Initial implement...
164
      local loc="$2"
a12d3140a   Shrikant Sharat   Removed bundle-in...
165
      local btype="$3"
843297b20   Shrikant Sharat   Initial implement...
166
      local branch="$4"
499c0dd5d   Shrikant Sharat   Added some comments.
167
      # The full location where the plugin is located.
843297b20   Shrikant Sharat   Initial implement...
168
      local location="$(-antigen-get-clone-dir "$url" "$branch")/$loc"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
169

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

d535ba468   Shrikant Sharat   Introduced a new ...
172
173
174
          # Of course, if its a theme, the location would point to the script
          # file.
          source "$location"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
175

d535ba468   Shrikant Sharat   Introduced a new ...
176
      else
e5dfac7ea   Shrikant Sharat   Initial commit. W...
177

d535ba468   Shrikant Sharat   Introduced a new ...
178
179
180
181
          # Source the plugin script
          # FIXME: I don't know. Looks very very ugly. Needs a better
          # implementation once tests are ready.
          local script_loc="$(ls "$location" | grep -m1 '.plugin.zsh$')"
499c0dd5d   Shrikant Sharat   Added some comments.
182

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

d535ba468   Shrikant Sharat   Introduced a new ...
187
188
189
190
          elif [[ ! -z "$(ls "$location" | grep -m1 '.zsh$')" ]]; then
              # If there is no `*.plugin.zsh` file, source *all* the `*.zsh`
              # files.
              for script ($location/*.zsh) source "$script"
499c0dd5d   Shrikant Sharat   Added some comments.
191

17f8e971e   Shrikant Sharat   Work with non zsh...
192
193
194
195
          elif [[ ! -z "$(ls "$location" | grep -m1 '.sh$')" ]]; then
              # If there are no `*.zsh` files either, we look for and source any
              # `*.sh` files instead.
              for script ($location/*.sh) source "$script"
499c0dd5d   Shrikant Sharat   Added some comments.
196

d535ba468   Shrikant Sharat   Introduced a new ...
197
          fi
499c0dd5d   Shrikant Sharat   Added some comments.
198
          # Add to $fpath, for completion(s).
d535ba468   Shrikant Sharat   Introduced a new ...
199
200
201
          fpath=($location $fpath)
  
      fi
e5dfac7ea   Shrikant Sharat   Initial commit. W...
202

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

499c0dd5d   Shrikant Sharat   Added some comments.
206
      # Cleanup unused repositories.
0b32bec27   Shrikant Sharat   bundle-cleanup co...
207
208
209
210
211
212
213
      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 \
843297b20   Shrikant Sharat   Initial implement...
214
          <(-antigen-echo-record | awk '{print $1 "|" $4}' | sort -u) \
0b32bec27   Shrikant Sharat   bundle-cleanup co...
215
          <(ls "$ADOTDIR/repos" | while read line; do
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
216
                  -antigen-get-clone-url "$line"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
217
218
219
220
221
222
223
224
              done))"
  
      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...
225
226
      echo "$unused_clones" \
          | sed -e 's/^/  /' -e 's/|/, branch /'
0b32bec27   Shrikant Sharat   bundle-cleanup co...
227
228
229
230
231
232
233
234
  
      echo -n '
  Delete them all? [y/N] '
      if read -q; then
          echo
          echo
          echo "$unused_clones" | while read url; do
              echo -n "Deleting clone for $url..."
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
235
              rm -rf "$(-antigen-get-clone-dir $url)"
0b32bec27   Shrikant Sharat   bundle-cleanup co...
236
237
238
239
240
241
242
              echo ' done.'
          done
      else
          echo
          echo Nothing deleted.
      fi
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
243
244
  antigen-lib () {
      antigen-bundle --loc=lib
e5dfac7ea   Shrikant Sharat   Initial commit. W...
245
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
246
  antigen-theme () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
247
      local name="${1:-robbyrussell}"
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
248
      antigen-bundle --loc=themes/$name.zsh-theme --btype=theme
e5dfac7ea   Shrikant Sharat   Initial commit. W...
249
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
250
  antigen-apply () {
e5dfac7ea   Shrikant Sharat   Initial commit. W...
251
      # Initialize completion.
a91386310   Shrikant Sharat   Add a todo note o...
252
253
      # TODO: Only load completions if there are any changes to the bundle
      # repositories.
e5dfac7ea   Shrikant Sharat   Initial commit. W...
254
255
      compinit -i
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
256
  antigen-list () {
df942673b   Shrikant Sharat   Added bundle-list...
257
      # List all currently installed bundles
9dc631003   Shrikant Sharat   Rename bundle rec...
258
      if [[ -z "$_ANTIGEN_BUNDLE_RECORD" ]]; then
df942673b   Shrikant Sharat   Added bundle-list...
259
260
261
          echo "You don't have any bundles." >&2
          return 1
      else
3aa0d2d8a   Shrikant Sharat   Fix duplicate ent...
262
          -antigen-echo-record | sort -u
df942673b   Shrikant Sharat   Added bundle-list...
263
264
      fi
  }
fee42de18   Shrikant Sharat   Add a small antig...
265
266
267
268
269
270
271
  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...
272
273
274
275
276
277
278
  # 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.
279
280
  # 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...
281
  -antigen-echo-record () {
9dc631003   Shrikant Sharat   Rename bundle rec...
282
      echo "$_ANTIGEN_BUNDLE_RECORD" | sed -n '1!p'
e5dfac7ea   Shrikant Sharat   Initial commit. W...
283
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
284
  -antigen-env-setup () {
3047bfeb7   Shrikant Sharat   Load compinit at ...
285
      # Pre-startup initializations
e5dfac7ea   Shrikant Sharat   Initial commit. W...
286
287
      -set-default ANTIGEN_DEFAULT_REPO_URL \
          https://github.com/robbyrussell/oh-my-zsh.git
911cc8cb5   Shrikant Sharat   Use ADOTDIR as th...
288
      -set-default ADOTDIR $HOME/.antigen
3047bfeb7   Shrikant Sharat   Load compinit at ...
289
290
291
292
293
294
  
      # Load the compinit module
      autoload -U compinit
  
      # Without the following, `compdef` function is not defined.
      compinit -i
e5dfac7ea   Shrikant Sharat   Initial commit. W...
295
296
297
298
299
  }
  
  # 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...
300
301
      local arg_name="$1"
      local arg_value="$2"
e5dfac7ea   Shrikant Sharat   Initial commit. W...
302
303
      eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'"
  }
a4f6e2fc8   Shrikant Sharat   Fix #2. Add `anti...
304
  -antigen-env-setup