4 SC2250

Joachim Ansorg edited this page 2021-11-12 19:54:54 +01:00

Table of Contents

• Prefer putting braces around variable references even when not strictly required.
• Problematic code:
• Correct code:
• Rationale:
• Related resources:

Prefer putting braces around variable references even when not strictly required.

This is an optional suggestion. It must be explicitly enabled with a directive enable=require-variable-braces in a # shellcheck comment or .shellcheckrc

Problematic code:

partial_path='example'

curl "http://example.com/$partial_path_version/explain.html"

Correct code:

partial_path='example'

curl "http://example.com/${partial_path}_version/explain.html"

Rationale:

If a variable gets called, and there is a string that gets appended to the variable that could get misinterpreted as possibly part of the name of the variable. Then it will not call the right variable.

Related resources:

• StackOverflow: How do we separate variables from letters in shell scripting

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.