Blame view

plugins/wd/wd.sh 9.97 KB
093a6c34b   mj   Squashed 'repos/r...
1
2
3
4
5
6
7
8
9
10
  #!/bin/zsh
  
  # WARP DIRECTORY
  # ==============
  # Jump to custom directories in terminal
  # because `cd` takes too long...
  #
  # @github.com/mfaerevaag/wd
  
  # version
7378b55de   mj   Squashed 'repos/r...
11
  readonly WD_VERSION=0.4.2
093a6c34b   mj   Squashed 'repos/r...
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
  
  # colors
  readonly WD_BLUE="\033[96m"
  readonly WD_GREEN="\033[92m"
  readonly WD_YELLOW="\033[93m"
  readonly WD_RED="\033[91m"
  readonly WD_NOC="\033[m"
  
  ## functions
  
  # helpers
  wd_yesorno()
  {
      # variables
      local question="${1}"
      local prompt="${question} "
      local yes_RETVAL="0"
      local no_RETVAL="3"
      local RETVAL=""
      local answer=""
  
      # read-eval loop
      while true ; do
          printf $prompt
          read -r answer
  
          case ${answer:=${default}} in
              Y|y|YES|yes|Yes )
                  RETVAL=${yes_RETVAL} && \
                      break
                  ;;
              N|n|NO|no|No )
                  RETVAL=${no_RETVAL} && \
                      break
                  ;;
              * )
                  echo "Please provide a valid answer (y or n)"
                  ;;
          esac
      done
  
      return ${RETVAL}
  }
  
  wd_print_msg()
  {
      if [[ -z $wd_quiet_mode ]]
      then
          local color=$1
          local msg=$2
  
          if [[ $color == "" || $msg == "" ]]
          then
              print " ${WD_RED}*${WD_NOC} Could not print message. Sorry!"
          else
              print " ${color}*${WD_NOC} ${msg}"
          fi
      fi
  }
  
  wd_print_usage()
  {
      cat <<- EOF
  Usage: wd [command] <point>
  
  Commands:
  	add <point>	Adds the current working directory to your warp points
  	add! <point>	Overwrites existing warp point
  	rm <point>	Removes the given warp point
  	show		Print warp points to current directory
  	show <point>	Print path to given warp point
56a5793ce   mj   Squashed 'repos/r...
83
84
85
  	list	        Print all stored warp points
  ls  <point>     Show files from given warp point
  path <point>    Show the path to given warp point
093a6c34b   mj   Squashed 'repos/r...
86
87
88
89
90
91
92
93
94
95
96
97
98
99
  	clean!		Remove points warping to nonexistent directories
  
  	-v | --version	Print version
  	-d | --debug	Exit after execution with exit codes (for testing)
  	-c | --config	Specify config file (default ~/.warprc)
  	-q | --quiet	Suppress all output
  
  	help		Show this extremely helpful text
  EOF
  }
  
  wd_exit_fail()
  {
      local msg=$1
56a5793ce   mj   Squashed 'repos/r...
100
      wd_print_msg $WD_RED $msg
093a6c34b   mj   Squashed 'repos/r...
101
102
103
104
105
106
107
108
109
110
      WD_EXIT_CODE=1
  }
  
  wd_exit_warn()
  {
      local msg=$1
  
      wd_print_msg $WD_YELLOW $msg
      WD_EXIT_CODE=1
  }
56a5793ce   mj   Squashed 'repos/r...
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  wd_getdir()
  {
      local name_arg=$1
  
      point=$(wd_show $name_arg)
      dir=${point:28+$#name_arg+7}
  
      if [[ -z $name_arg ]]; then
          wd_exit_fail "You must enter a warp point"
          break
      elif [[ -z $dir ]]; then
          wd_exit_fail "Unknown warp point '${name_arg}'"
          break
      fi
  }
093a6c34b   mj   Squashed 'repos/r...
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
  # core
  
  wd_warp()
  {
      local point=$1
  
      if [[ $point =~ "^\.+$" ]]
      then
          if [ $#1 < 2 ]
          then
              wd_exit_warn "Warping to current directory?"
          else
              (( n = $#1 - 1 ))
              cd -$n > /dev/null
          fi
      elif [[ ${points[$point]} != "" ]]
      then
7378b55de   mj   Squashed 'repos/r...
143
          cd ${points[$point]/#\~/$HOME}
093a6c34b   mj   Squashed 'repos/r...
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
      else
          wd_exit_fail "Unknown warp point '${point}'"
      fi
  }
  
  wd_add()
  {
      local force=$1
      local point=$2
  
      if [[ $point =~ "^[\.]+$" ]]
      then
          wd_exit_fail "Warp point cannot be just dots"
      elif [[ $point =~ "[[:space:]]+" ]]
      then
          wd_exit_fail "Warp point should not contain whitespace"
      elif [[ $point == *:* ]]
      then
          wd_exit_fail "Warp point cannot contain colons"
      elif [[ $point == "" ]]
      then
          wd_exit_fail "Warp point cannot be empty"
      elif [[ ${points[$2]} == "" ]] || $force
      then
          wd_remove $point > /dev/null
7378b55de   mj   Squashed 'repos/r...
169
170
          printf "%q:%s
  " "${point}" "${PWD/#$HOME/~}" >> $WD_CONFIG
093a6c34b   mj   Squashed 'repos/r...
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
  
          wd_print_msg $WD_GREEN "Warp point added"
  
          # override exit code in case wd_remove did not remove any points
          # TODO: we should handle this kind of logic better
          WD_EXIT_CODE=0
      else
          wd_exit_warn "Warp point '${point}' already exists. Use 'add!' to overwrite."
      fi
  }
  
  wd_remove()
  {
      local point=$1
  
      if [[ ${points[$point]} != "" ]]
      then
          local config_tmp=$WD_CONFIG.tmp
          if sed -n "/^${point}:.*$/!p" $WD_CONFIG > $config_tmp && mv $config_tmp $WD_CONFIG
          then
              wd_print_msg $WD_GREEN "Warp point removed"
          else
              wd_exit_fail "Something bad happened! Sorry."
          fi
      else
          wd_exit_fail "Warp point was not found"
      fi
  }
  
  wd_list_all()
  {
      wd_print_msg $WD_BLUE "All warp points:"
7378b55de   mj   Squashed 'repos/r...
203
204
205
206
207
208
209
210
211
212
213
214
215
216
      entries=$(sed "s:${HOME}:~:g" $WD_CONFIG)
  
      max_warp_point_length=0
      while IFS= read -r line
      do
          arr=(${(s,:,)line})
          key=${arr[1]}
  
          length=${#key}
          if [[ length -gt max_warp_point_length ]]
          then
              max_warp_point_length=$length
          fi
      done <<< $entries
093a6c34b   mj   Squashed 'repos/r...
217
218
219
220
221
222
223
224
225
226
      while IFS= read -r line
      do
          if [[ $line != "" ]]
          then
              arr=(${(s,:,)line})
              key=${arr[1]}
              val=${arr[2]}
  
              if [[ -z $wd_quiet_mode ]]
              then
7378b55de   mj   Squashed 'repos/r...
227
228
                  printf "%${max_warp_point_length}s  ->  %s
  " $key $val
093a6c34b   mj   Squashed 'repos/r...
229
230
              fi
          fi
7378b55de   mj   Squashed 'repos/r...
231
      done <<< $entries
093a6c34b   mj   Squashed 'repos/r...
232
  }
56a5793ce   mj   Squashed 'repos/r...
233
234
235
  wd_ls()
  {
      wd_getdir $1
7378b55de   mj   Squashed 'repos/r...
236
      ls ${dir/#\~/$HOME}
56a5793ce   mj   Squashed 'repos/r...
237
238
239
240
241
242
243
  }
  
  wd_path()
  {
      wd_getdir $1
      echo $(echo $dir | sed "s:${HOME}:~:g")
  }
093a6c34b   mj   Squashed 'repos/r...
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
  wd_show()
  {
      local name_arg=$1
      # if there's an argument we look up the value
      if [[ ! -z $name_arg ]]
      then
          if [[ -z $points[$name_arg] ]]
          then
              wd_print_msg $WD_BLUE "No warp point named $name_arg"
          else
              wd_print_msg $WD_GREEN "Warp point: ${WD_GREEN}$name_arg${WD_NOC} -> $points[$name_arg]"
          fi
      else
          # hax to create a local empty array
          local wd_matches
          wd_matches=()
          # do a reverse lookup to check whether PWD is in $points
7378b55de   mj   Squashed 'repos/r...
261
          PWD="${PWD/$HOME/~}"
093a6c34b   mj   Squashed 'repos/r...
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
          if [[ ${points[(r)$PWD]} == $PWD ]]
          then
              for name in ${(k)points}
              do
                  if [[ $points[$name] == $PWD ]]
                  then
                      wd_matches[$(($#wd_matches+1))]=$name
                  fi
              done
  
              wd_print_msg $WD_BLUE "$#wd_matches warp point(s) to current directory: ${WD_GREEN}$wd_matches${WD_NOC}"
          else
              wd_print_msg $WD_YELLOW "No warp point to $(echo $PWD | sed "s:$HOME:~:")"
          fi
      fi
  }
  
  wd_clean() {
      local force=$1
      local count=0
      local wd_tmp=""
  
      while read line
      do
          if [[ $line != "" ]]
          then
              arr=(${(s,:,)line})
              key=${arr[1]}
              val=${arr[2]}
  
              if [ -d "$val" ]
              then
                  wd_tmp=$wd_tmp"
  "`echo $line`
              else
                  wd_print_msg $WD_YELLOW "Nonexistent directory: ${key} -> ${val}"
                  count=$((count+1))
              fi
          fi
      done < $WD_CONFIG
  
      if [[ $count -eq 0 ]]
      then
          wd_print_msg $WD_BLUE "No warp points to clean, carry on!"
      else
          if $force || wd_yesorno "Removing ${count} warp points. Continue? (Y/n)"
          then
              echo $wd_tmp >! $WD_CONFIG
              wd_print_msg $WD_GREEN "Cleanup complete. ${count} warp point(s) removed"
          else
              wd_print_msg $WD_BLUE "Cleanup aborted"
          fi
      fi
  }
  
  local WD_CONFIG=$HOME/.warprc
  local WD_QUIET=0
  local WD_EXIT_CODE=0
  local WD_DEBUG=0
  
  # Parse 'meta' options first to avoid the need to have them before
  # other commands. The `-D` flag consumes recognized options so that
  # the actual command parsing won't be affected.
  
  zparseopts -D -E \
      c:=wd_alt_config -config:=wd_alt_config \
      q=wd_quiet_mode -quiet=wd_quiet_mode \
      v=wd_print_version -version=wd_print_version \
      d=wd_debug_mode -debug=wd_debug_mode
  
  if [[ ! -z $wd_print_version ]]
  then
      echo "wd version $WD_VERSION"
  fi
  
  if [[ ! -z $wd_alt_config ]]
  then
      WD_CONFIG=$wd_alt_config[2]
  fi
  
  # check if config file exists
  if [ ! -e $WD_CONFIG ]
  then
      # if not, create config file
      touch $WD_CONFIG
  fi
  
  # load warp points
  typeset -A points
  while read -r line
  do
      arr=(${(s,:,)line})
      key=${arr[1]}
      val=${arr[2]}
  
      points[$key]=$val
  done < $WD_CONFIG
  
  # get opts
56a5793ce   mj   Squashed 'repos/r...
361
  args=$(getopt -o a:r:c:lhs -l add:,rm:,clean\!,list,ls:,path:,help,show -- $*)
093a6c34b   mj   Squashed 'repos/r...
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
  
  # check if no arguments were given, and that version is not set
  if [[ ($? -ne 0 || $#* -eq 0) && -z $wd_print_version ]]
  then
      wd_print_usage
  
      # check if config file is writeable
  elif [ ! -w $WD_CONFIG ]
  then
      # do nothing
      # can't run `exit`, as this would exit the executing shell
      wd_exit_fail "\'$WD_CONFIG\' is not writeable."
  
  else
  
      # parse rest of options
      for o
      do
          case "$o"
              in
              -a|--add|add)
                  wd_add false $2
                  break
                  ;;
              -a!|--add!|add!)
                  wd_add true $2
                  break
                  ;;
              -r|--remove|rm)
                  wd_remove $2
                  break
                  ;;
56a5793ce   mj   Squashed 'repos/r...
394
              -l|list)
093a6c34b   mj   Squashed 'repos/r...
395
396
397
                  wd_list_all
                  break
                  ;;
56a5793ce   mj   Squashed 'repos/r...
398
399
400
401
402
403
404
405
              -ls|ls)
                  wd_ls $2
                  break
                  ;;
              -p|--path|path)
                  wd_path $2
                  break
                  ;;
093a6c34b   mj   Squashed 'repos/r...
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
              -h|--help|help)
                  wd_print_usage
                  break
                  ;;
              -s|--show|show)
                  wd_show $2
                  break
                  ;;
              -c|--clean|clean)
                  wd_clean false
                  break
                  ;;
              -c!|--clean!|clean!)
                  wd_clean true
                  break
                  ;;
              *)
                  wd_warp $o
                  break
                  ;;
              --)
                  break
                  ;;
          esac
      done
  fi
  
  ## garbage collection
  # if not, next time warp will pick up variables from this run
  # remember, there's no sub shell
  
  unset wd_warp
  unset wd_add
  unset wd_remove
  unset wd_show
  unset wd_list_all
  unset wd_print_msg
  unset wd_yesorno
  unset wd_print_usage
  unset wd_alt_config
  unset wd_quiet_mode
  unset wd_print_version
  
  unset args
  unset points
  unset val &> /dev/null # fixes issue #1
  
  if [[ ! -z $wd_debug_mode ]]
  then
      exit $WD_EXIT_CODE
  else
      unset wd_debug_mode
  fi