1 SC1135

Vidar Holen edited this page 2019-06-30 19:04:39 -07:00

Table of Contents

• Prefer escape over ending quote to make $ literal. Instead of "It costs $"5, use "It costs $5"
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

Prefer escape over ending quote to make $ literal. Instead of "It costs $"5, use "It costs \$5"

Problematic code:

echo "The apples are $""1 each"
eval "var=$"name

Correct code:

echo "The apples are \$1 each"
eval "var=\$name"
# or better yet: var="${!name}"

Rationale:

The script appears to be closing a double quoted string for the sole purpose of making a dollar sign $ literal.

While this happens to work, the better solution is instead to escape it with a backslash. This allows the double quoted string to continue uninterrupted, thereby reducing the visual noise of stopping and starting quotes in the middle of a shell word.

Exceptions:

None

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.