2 SC3014

Lawrence Velázquez edited this page 2024-03-08 01:40:24 -05:00

Table of Contents

• In POSIX sh, == in place of = is undefined.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

In POSIX sh, == in place of = is undefined.

(or "In dash, ... is not supported." when using dash)

Problematic code:

#!/bin/sh
if [ $1 == "-n" ]
then
  dry_run=1
fi

Correct code:

#!/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:

• Greg's Wiki
  • Bash Pitfall #20: [ bar == "$foo" ]
  • Bashism - Conditionals

ShellCheck

• Installation

  • CentOS6
  • More Installation Guides

• Usage

  • Directive
  • Ignore

• Integrating and extending

  • Misc. contributions
  • Azure Pipelines
  • Buildkite
  • CircleCI
  • DevGuide
  • Integration
  • JUnit
  • Phabricator
  • TravisCI
  • GitLab CI
  • Drone
  • GitHub Actions

• Severity

• Template

Each individual ShellCheck warning has its own wiki page like SC1000. Use GitHub Wiki's "Pages" feature above to find a specific one, or see Checks.