2 SC1124

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

Table of Contents

• ShellCheck directives are only valid in front of complete commands like case statements, not individual case branches.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:

ShellCheck directives are only valid in front of complete commands like case statements, not individual case branches.

Problematic code:

case $? in
  0) echo "Success" ;;
  # shellcheck disable=2154
  *) echo "$cmd $flag returned failure" ;;
esac

Correct code:

# Applies to everything in the `case` statement
# shellcheck disable=2154
case $? in
  0) echo "Success" ;;
  *) echo "$cmd $flag returned failure" ;;
esac

or

case $? in
  0) echo "Success" ;;
  *)
     # Applies to a single command within the `case`
     # shellcheck disable=2154
     echo "$cmd $flag returned failure"
     ;;
esac

Rationale:

You appear to have put a directive before a branch in a case statement.

ShellCheck directives can not be scoped to individual branches of case statements, only to the entire case, or to individual commands within it. Please move the directive as appropriate.

(It is possible to apply directives to all commands within a { ..: } command group, if you truly wish to apply a directive to multiple commands but not the full case statement.)

Exceptions:

None.

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.