Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(typo): three typos #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(typo): three typos #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/Bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ An attempt to bring order in good advice on writing Bash scripts I collected fro

- Prefer local variables within functions over global variables
- If you need global variables, make them readonly
- Variables should always be referred to in the `${var}` form (as opposed to `$var`.
- Variables should always be referred to in the `${var}` form (as opposed to `$var`).
- Variables should always be quoted, especially if their value may contain a whitespace or separator character: `"${var}"`
- Capitalization:
- Environment (exported) variables: `${ALL_CAPS}`
- Local variables: `${lower_case}`
- Positional parameters of the script should be checked, those of functions should not
- Some loops happen in subprocesses, so don’t be surprised when setting variabless does nothing after them. Use stdout and `grep`ing to communicate status.
- Some loops happen in subprocesses, so don’t be surprised when setting variables does nothing after them. Use stdout and `grep`ing to communicate status.

## Substitution

Expand Down Expand Up @@ -162,7 +162,7 @@ Bash is not very easy to debug. There's no built-in debugger like you have with

- Always check for syntax errors by running the script with `bash -n myscript.sh`
- Use [ShellCheck](https://www.shellcheck.net/) and fix all warnings. This is a static code analyzer that can find a lot of common bugs in shell scripts. Integrate ShellCheck in your text editor (e.g. Syntastic plugin in Vim)
- Abort the script on errors and undbound variables. Put the following code at the beginning of each script.
- Abort the script on errors and unbound variables. Put the following code at the beginning of each script.

```bash
set -o errexit # abort on nonzero exitstatus
Expand Down