From 2084b048aee7bb9cea337da0704f5a2798c44044 Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Tue, 1 Sep 2020 17:22:13 -0700 Subject: [PATCH] Created SC3014 (markdown) --- SC3014.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 SC3014.md diff --git a/SC3014.md b/SC3014.md new file mode 100644 index 0000000..0711c6c --- /dev/null +++ b/SC3014.md @@ -0,0 +1,41 @@ +## In POSIX sh, `==` in place of `=` is undefined. + +(or "In dash, ... is not supported." when using `dash`) + +### Problematic code: + +```sh +#!/bin/sh +if [ $1 == "-n" ] +then + dry_run=1 +fi +``` + +### Correct code: + +```sh +#!/bin/sh +if [ $1 = "-n" ] +then + dry_run=1 +fi +``` + +### Rationale: + +`==` is used for equality comparison in C-like languages, and is also supported by `bash` and `ksh` in `[ .. ]` and `test` expressions. + +`sh` and `dash` only supports `=` for equality comparison, so use that instead. + +### Exceptions: + +If you only intend to target shells that supports this feature, you can change +the shebang to a shell that guarantees support, or [[ignore]] this warning. + +You can use `# shellcheck disable=SC3000-SC4000` to ignore all such compatibility +warnings. + +### Related resources: + +* Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc!