This repository has been archived by the owner on Sep 24, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
.gosh.sh
478 lines (452 loc) · 11.3 KB
/
.gosh.sh
1
2
3
4
5
6
7
8
9
10
11
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
169
170
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
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
361
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
394
395
396
397
398
399
400
401
402
403
404
405
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
#!/usr/bin/env bash
# Return 0 if $1 is a set variable, 1 otherwise.
function _g_varset {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <var>" >&2
echo "(got: $@)" >&2
exit 1
fi
local var="$1"
if [[ ! ${!var} && ${!var-unset} ]]; then
return 1
fi
return 0
}
# Return 0 if $1 is not a set variable, 1 otherwise.
function _g_varunset {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <var>" >&2
echo "(got: $@)" >&2
exit 1
fi
local var="$1"
if [[ ! ${!var} && ${!var-unset} ]]; then
return 0
fi
return 1
}
# Returns 0 if $1 is in PATH, 1 otherwise.
function _g_in_path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <path>" >&2
echo "(got: $@)" >&2
exit 1
fi
# PATH -> to array
local path_array
OLDIFS=$IFS
IFS=":" path_array=($PATH)
IFS=$OLDIFS
for path in "${path_array[@]}"; do
if [ "$path" == "$1" ]; then
return 0
fi
done
return 1
}
# Adds $1 to PATH, unless it's already there.
function _g_add_path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <path>" >&2
echo "(got: $@)" >&2
exit 1
fi
if ! _g_in_path "$1"; then
export PATH="$1":$PATH
fi
}
# Removes $1 from PATH, if it's there.
function _g_rm_path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <path>" >&2
echo "(got: $@)" >&2
exit 1
fi
local new_path=
# PATH -> to array
local path_array
OLDIFS=$IFS
IFS=":" path_array=($PATH)
IFS=$OLDIFS
for path in "${path_array[@]}"; do
if [ "$path" == "$1" ]; then
continue
fi
if [ -z "$new_path" ]; then
new_path="$path"
else
new_path="$path:$new_path"
fi
done
export PATH=$new_path
}
# Default a variable named $1 to $2 unless already set.
# This is more readable than expansion syntax.
# E.g.,
# default foo bar
#
# This is a less verbose, more readable form of:
# export FOO="${FOO:=$BAR}"
#
function default {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <default value>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
export $1="$2"
fi
}
# Default a variable named $1 to $2 unless already set,
# and be verbose about it. This is a verbose variant of
# the default function.
# E.g.,
# vdefault foo bar
#
# This is a less verbose, more readable form of:
# if [ -z "$FOO" ]; then
# echo "..."
# export FOO="${BAR}"
# fi
#
function vdefault {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <default value>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
echo "Variable \"$1\" is being defaulted to \"$2\"."
export $1="$2"
fi
}
# Override the variable named $1 by setting it to $2.
# This is mostly for consistency with the default function.
# E.g.,
# override foo bar
function override {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <override value>" >&2
echo "(got: $@)" >&2
exit 1
fi
export $1="$2"
}
# Override the variable named $1 by setting it to $2,
# and be verbose about it. This is a verbose variant of
# the override function.
# E.g.,
# voverride foo bar
function voverride {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <override value>" >&2
echo "(got: $@)" >&2
exit 1
fi
echo "Overriding variable \"$1\" and setting it to \"$2\"."
export $1="$2"
}
# Prepends $2 to the variable named $1. If $1 is not already set, it will be
# set to $2.
# E.g.,
# prepend PATH $(pwd)/bin
function prepend {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <value>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
export $1="$2"
else
local current=$1
export $1="$2:${!current}"
fi
}
# Prepends $2 to the variable named $1, and be verbose about it. If $1 is not
# already set, it will be set to $2.
# E.g.,
# vprepend PATH $(pwd)/bin
function vprepend {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <value>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
echo "Variable \"$1\" is being set to \"$2\"."
export $1="$2"
else
echo "Variable \"$1\" is being prepended with \"$2\"."
local current=$1
export $1="$2:${!current}"
fi
}
# Appends $2 to the variable named $1. If $1 is not already set, it will be
# set to $2.
# E.g.,
# append PATH $(pwd)/bin
function append {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <value>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
export $1="$2"
else
local current=$1
export $1="${!current}:$2"
fi
}
# Prepends $2 to the variable named $1. If $1 is not already set, it will be
# set to $2.
# E.g.,
# prepend PATH $(pwd)/bin
function vappend {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <value>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
echo "Variable \"$1\" is being set to \"$2\"."
export $1="$2"
else
echo "Variable \"$1\" is being appended to with \"$2\"."
local current=$1
export $1="$2:${!current}"
fi
}
# Returns 1 if the environment variable $1 is in PATH, 0 otherwise.
# E.g.,
# in-path $HOME/bin
function in-path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <var>" >&2
echo "(got: $@)" >&2
exit 1
fi
if [[ ":$PATH:" == *":$1:"* ]]; then
return 0
fi
return 1
}
# Returns 1 if the environment variable $1 is in PATH, 0 otherwise.
# This is a verbose variant of the in-path function.
# E.g.,
# vin-path $HOME/bin
function vin-path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <var>" >&2
echo "(got: $@)" >&2
exit 1
fi
if [[ ":$PATH:" == *":$1:"* ]]; then
echo "PATH contains \"$1\"."
return 0
fi
echo "PATH does not contain \"$1\"."
return 1
}
# Returns 1 if the environment variable $1 is not in PATH, 0 otherwise.
# E.g.,
# not-in-path $HOME/bin
function not-in-path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <var>" >&2
echo "(got: $@)" >&2
exit 1
fi
if [[ ":$PATH:" == *":$1:"* ]]; then
return 1
fi
return 0
}
# Returns 1 if the environment variable $1 is not in PATH, 0 otherwise.
# This is a verbose variant of the not-in-path function.
# E.g.,
# vnot-in-path $HOME/bin
function vnot-in-path {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <var>" >&2
echo "(got: $@)" >&2
exit 1
fi
if [[ ":$PATH:" == *":$1:"* ]]; then
echo "PATH contains \"$1\"."
return 1
fi
echo "PATH does not contain \"$1\"."
return 0
}
# Returns 1 if the environment variable $1 is not set, 0 otherwise.
# E.g.,
# assert-env PATH
function assert-env {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
echo "$1 is not set" 1>&2
return 1
fi
return 0
}
# Exits 1 if the environment variable $1 is not set.
# E.g.,
# assert-env-or-die PATH
function assert-env-or-die {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
echo "$1 is not set" 1>&2
exit 1
fi
}
# Prompt the user to set a variable if it does not have a default value.
# E.g.,
# prompt-env VERSION "VERSION is not set, please set it now: "
function prompt-env {
if [ $# -ne 2 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <prompt>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
read -p "$2" REPLY
if [ -z "$REPLY" ]; then
echo "no response" >&2
return 1
fi
export $1="$REPLY"
fi
return 0
}
# Prompt the user to set a variable if it does not have a default value, and
# be verbose about it.
# E.g.,
# vprompt-env VERSION "VERSION not set, please set it now: " "VERSION is: "
function vprompt-env {
if [ $# -ne 3 ]; then
local me=FUNCNAME
echo "usage: ${!me} <variable> <prompt> <verbose>" >&2
echo "(got: $@)" >&2
exit 1
fi
if _g_varunset "$1"; then
read -p "$2" REPLY
if [ -z "$REPLY" ]; then
echo "no response" >&2
return 1
fi
export $1="$REPLY"
else
local current=$1
echo "${3}\"${!current}\"."
fi
return 0
}
# Sources the file named $1, if readable. The return code of the source
# operation is returned to allow for failure conditions when sourcing a
# file.
# E.g.,
# assert-source template.sh || exit 1
#
# Sourcing a file that does not exist is normally a failure. This function
# does not. The following example will *not* execute the exit statement.
# E.g.,
# assert-source does-not-exist.sh || exit 1
#
function assert-source {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <file>" >&2
echo "(got: $@)" >&2
exit 1
fi
if [ -r "$1" ]; then
source "$1"
RC=$?
if [ $RC -ne 0 ]; then
local me=FUNCNAME
echo "${!me}: source failure in $1; returned $RC" >&2
return $RC
fi
fi
return 0
}
# Returns 1 if the command $1 is not found, 0 otherwise.
# E.g.,
# require-cmd realpath
function require-cmd {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <command>" >&2
echo "(got: $@)" >&2
exit 1
fi
_=$(which "$1" >/dev/null 2>&1)
if [ $? -eq 1 ]; then
echo "$1: command not found (and it is required)" 2>&2
return 1
fi
return 0
}
# Exits 1 if the required command is not found.
# E.g.,
# require-cmd-or-die realpath
function require-cmd-or-die {
if [ $# -ne 1 ]; then
local me=FUNCNAME
echo "usage: ${!me} <command>" >&2
echo "(got: $@)" >&2
exit 1
fi
_=$(which "$1" >/dev/null 2>&1)
if [ $? -eq 1 ]; then
echo "$1: command not found (and it is required)" 2>&2
exit 1
fi
}
# Pull in any GOSH_CONTRIB scripts found.
function use-gosh-contrib {
assert-env GOSH_CONTRIB || return 1
for contrib in "$GOSH_CONTRIB"/*.sh; do
assert-source "$contrib" || return 1
done
return 0
}
# Exits 1 unless all GOSH_CONTRIB scripts are pulled in.
function use-gosh-contrib-or-die {
assert-env-or-die GOSH_CONTRIB
for contrib in "$GOSH_CONTRIB"/*.sh; do
assert-source "$contrib" || exit 1
done
}