1 SC2309

Vidar Holen edited this page 2021-08-30 20:16:19 -07:00

Unescape Escape

Table of Contents

• -eq treats this as a variable. Use = to compare as string (or expand explicitly with $var)
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

-eq treats this as a variable. Use = to compare as string (or expand explicitly with $var)

Problematic code:

read -p "Continue? [y/n] " var
[ "$var" -eq "n" ​] && exit 1

Correct code:

#read -p "Continue? [y/n] " var
[ "$var" = "n" ​] && exit 1

Rationale:

ShellCheck found a string used as an argument to a numerical operator like -eq, -ne, -lt, -ge. Such strings will be treated as arithmetic expressions, meaning n will refer to a variable $n, and 24/12 will be evaluated into 2.

In the problematic example, the intention was instead to compare "n" as a string, so it should use the equivalent string operator instead, in this case =.

Exceptions:

It is perfectly valid to use variables as operands. ShellCheck will not flag any value that is an unquoted variable name assigned in the script:

a=42; [[ "a" -eq 0 ]]  # Flagged due to quotes
      [[ b -eq 0 ]]    # Flagged due to not being assigned
c=42; [[ c -eq 0 ]]    # Not flagged

However, ShellCheck does not know whether you intended foo/bar to be division or a file path.

If you intended to divide $foo and $bar, you can either make it explicit with [[ $((foo/bar)) -ge 0 ]], or simply ignore the warning.

Related resources:

• Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc

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.