1 SC2300

Vidar Holen edited this page 2021-08-16 21:58:45 -07:00

Table of Contents

• Parameter expansion can't be applied to command substitutions. Use temporary variables.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

Parameter expansion can't be applied to command substitutions. Use temporary variables.

Problematic code:

echo "Building ${$(git rev-parse --show-toplevel)##*/}"

Correct code:

tmp=$(git rev-parse --show-toplevel)
echo "Building ${tmp##*/}"

Rationale:

ShellCheck found a parameter expansion that begins with a command substitution, such as $(..) or `..`. This is not valid. Parameter expansion only works on variables (normal or special).

In the example, the user hoped to apply the construct ${var##*/}, stripping the path, to the current git root directory as output by git rev-parse --show-toplevel. Since parameter expansion only works on variable, the command substitution must be assigned to a variable first like in the correct example.

If the goal was instead to dynamically generate a variable name to expand, see SC2082.

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.