docs: run `brew generate-man-completions`
[Homebrew/brew.git] / .shellcheckrc
blob5fb9c0db2f9afe6844574bd9322fa853f85b44d3
1 # Look for 'source'd files relative to the current working directory where the
2 # shellcheck command is invoked.
3 source-path=Library
5 # Allow opening any 'source'd file, even if not specified as input
6 external-sources=true
8 # SC2310: This function is invoked in an 'if' / ! condition so set -e will be
9 # disabled. Invoke separately if failures should cause the script to exit.
10 # See: https://github.com/koalaman/shellcheck/wiki/SC2310
12 # We don't use the `set -e` feature in Bash scripts yet.
13 # We do need the return status as condition for if switches.
14 # Allow `if command` and `if ! command`.
15 disable=SC2310
17 # SC2311: Bash implicitly disabled set -e for this function invocation because
18 # it's inside a command substitution. Add set -e; before it or enable inherit_errexit.
19 # See: https://github.com/koalaman/shellcheck/wiki/SC2311
21 # We don't use the `set -e` feature in Bash scripts yet.
22 # We don't need return codes for "$(command)", only stdout is needed.
23 # Allow `var="$(command)"`, etc.
24 disable=SC2311
26 # SC2312: Consider invoking this command separately to avoid masking its return
27 # value (or use '|| true' to ignore).
28 # See: https://github.com/koalaman/shellcheck/wiki/SC2312
30 # We don't need return codes for "$(command)", only stdout is needed.
31 # Allow `[[ -n "$(command)" ]]`, `func "$(command)"`, pipes, etc.
32 disable=SC2312