summaryrefslogtreecommitdiffstats
path: root/docs/BASH.md
blob: e72a2f664296702fff116bfe9166f42b46f1789a (plain)
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
# BASH Notes

## basename
Don't use `basename`, use:
```shell
  file=${path##*/}
```

## dirname
Don't use `dirname`, use:
```shell
  dir=${path%/*}
```

## shopt
If you set `shopt` in a function, reset to its default state with `trap`:
```shell
func() {
  trap "$(shopt -p globstar)" RETURN
  shopt -q -s globstar
}
```

## find, grep, print0, -0, -z

Don't use `find` in `for` loops, because filenames can contain spaces.
Try to use `globstar` and `nullglob` or null byte terminated strings.

Instead of:
```shell
func() {
    for file in $(find /usr/lib* -type f -name 'lib*.a' -print0 ); do
      echo $file
    done
}
```

use:
```shell
func() {
    trap "$(shopt -p nullglob globstar)" RETURN
    shopt -q -s nullglob globstar

    for file in /usr/lib*/**/lib*.a; do
      [[ -f $file ]] || continue
      echo "$file"
    done
}
```

Or collect the filenames in an array, if you need them more than once:
```shell
func() {
    trap "$(shopt -p globstar)" RETURN
    shopt -q -s globstar

    filenames=( /usr/lib*/**/lib*.a )

    for file in "${filenames[@]}"; do
      [[ -f $file ]] || continue
      echo "$file"
    done
}
```

Or, if you really want to use `find`, use `-print0` and an array:
```shell
func() {
    mapfile -t -d '' filenames < <(find /usr/lib* -type f -name 'lib*.a' -print0)
    for file in "${filenames[@]}"; do
      echo "$file"
    done
}
```

Note: `-d ''` is the same as `-d $'\0'` and sets the null byte as the delimiter.

or:
```shell
func() {
    find /usr/lib* -type f -name 'lib*.a' -print0 | while read -r -d '' file; do
      echo "$file"
    done
}
```

or
```shell
func() {
    while read -r -d '' file; do
      echo "$file"
    done < <(find /usr/lib* -type f -name 'lib*.a' -print0)
}
```

Use the tool options for null terminated strings, like `-print0`, `-0`, `-z`, etc.

## prefix or suffix array elements

Instead of:
```shell
func() {
  other-cmd $(for k in "$@"; do echo "prefix-$k"; done)
}
```
do
```shell
func() {
  other-cmd "${@/#/prefix-}"
}
```

or suffix:
```shell
func() {
  other-cmd "${@/%/-suffix}"
}
```

## Join array elements with a separator char

Here we have an associate array `_drivers`, where we want to print the keys separated by ',':
```shell
    if [[ ${!_drivers[*]} ]]; then
        echo "rd.driver.pre=$(IFS=, ;echo "${!_drivers[*]}")" > "${initdir}"/etc/cmdline.d/00-watchdog.conf
    fi
```

## Optional parameters to commands

If you want to call a command `cmd` with an option, if a variable is set, rather than doing:

```shell
func() {
  local param="$1"

  if [[ $param ]]; then
    param="--this-special-option $param"
  fi

  cmd $param
}
```

do it like this:

```shell
func() {
  local param="$1"

  cmd ${param:+--this-special-option "$param"}
}

# cmd --this-special-option 'abc'
func 'abc'

# cmd
func ''

# cmd
func
```

If you want to specify the option even with an empty string do this:

```shell
func() {
  local -a special_params

  if [[ ${1+_} ]]; then
    # only declare `param` if $1 is set (even as null string)
    local param="$1"
  fi

  # check if `param` is set (even as null string)
  if [[ ${param+_} ]]; then
    special_params=( --this-special-option "${param}" )
  fi

  cmd ${param+"${special_params[@]}"}
}

# cmd --this-special-option 'abc'
func 'abc'

# cmd --this-special-option ''
func ''

# cmd
func
```

Or more simple, if you only have to set an option:
```shell
func() {
  if [[ ${1+_} ]]; then
    # only declare `param` if $1 is set (even as null string)
    local param="$1"
  fi

  cmd ${param+--this-special-option}
}

# cmd --this-special-option
func 'abc'

# cmd --this-special-option
func ''

# cmd
func
```