diff --git a/SC2283.md b/SC2283.md new file mode 100644 index 0000000..3cbc5e7 --- /dev/null +++ b/SC2283.md @@ -0,0 +1,45 @@ +## Use [ ] to compare values, or remove spaces around = to assign (or quote '=' if literal). + +### Problematic code: + +```sh +# Assignment +var = value + +# Comparison +if $var = value +then + echo "Match" +fi +``` + +### Correct code: + +```sh +# Assignment +var=value + +# Comparison +if [ "$var" = value ] +then + echo "Match" +fi +``` + +### Rationale: + +ShellCheck found an unquoted `=` after a word. + +If this was supposed to be a comparison, use square brackets: `[ "$var" = value ]` + +If this was supposed to be an assignment, remove spaces around `=`: `var=value` + +### Exceptions: + +If the `=` was meant literally, quote it: + + grep '=true' file.cfg + +### Related resources: + +* Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc! \ No newline at end of file