blob: 89d98fd44328741d36b6cf118bbd873a56b15356 (
plain) (
blame)
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
|
---
title: Bash
subtitle: best practices
---
(Associative) arrays
--------------------
### Declaration
`"${#xs[@]}"` doesn't work with `nounset` if `xs` wasn't defined, i.e. was
declared with either of
```bash
local -a xs
declare -a xs
local -A xs
declare -A xs
```
Therefore, if you want to extract the length of an array, append `=()` to the
statements above.
```bash
local -a xs=()
declare -a xs=()
```
And now `"${#xs[@]}"` works with `nounset`.
It doesn't affect expansion (see below) though.
### Expansion
#### Do
```bash
func ${arr[@]+"${arr[@]}"}
```
#### Don't
```bash
func "${arr[@]}" # Doesn't work with `nounset`.
func "${arr[@]+"${arr[@]}"}" # Doesn't work properly with `declare -a arr=('')`.
```
### `unset`
#### Do
```bash
unset -v 'arr[x]'
unset -v 'arr[$i]'
```
#### Don't
```bash
unset -v arr[x] # May break due to globbing.
unset -v arr[$i] # The same as above + a possible problem with quotation.
unset -v 'arr["x"]' # Doesn't work for some reason.
unset -v 'arr["]"]' # The same as above; just highlighting the problem with funny characters in array indices.
unset -v 'arr["$i"]' # Also rejected.
# An insightful discussion on the topic: https://lists.gnu.org/archive/html/help-bash/2016-09/msg00020.html.
```
`errexit`
---------
I hate this feature, and I especially hate people who prefer "standards" over
useful behaviour.
### Command substitution
#### Do
```bash
shopt -s inherit_errexit # Without this, bar will be executed w/ errexit disabled!
bar() {
false
echo 'should never see this' >&2
}
bar_output="$( bar )"
foo "$bar_output"
```
#### Don't
```bash
bar() {
false
echo 'should never see this' >&2
}
foo "$( bar )" # Even with errexit, foo will still get executed.
# More than that, the script will print 'should never see this'!
```
### Process substitution
#### Do
```bash
shopt -s lastpipe
command | while IFS= read -r line; do
process_line "$line"
done
```
#### Don't
```bash
# Without lastpipe, you cannot pipe into read:
command | while IFS= read -r line; do
process_line "$line"
done
```
```bash
# errexit doesn't work here no matter what:
while IFS= read -r line; do
process_line "$line"
done < <( command )
echo 'should never see this'
```
```bash
# This would break if $output contains the \0 byte:
output="$( command )"
while IFS= read -r line; do
process_line "$line"
done <<< "$output"
```
### Functions
#### Do
```bash
foo() {
false
echo 'should never see this' >&2
}
foo
echo ok
```
#### Don't
```bash
if foo; then
echo ok # foo will still print 'should never see this'.
fi
foo && echo ok # Same here.
foo || echo ok
```
|
