4 SC2213

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

Table of Contents

• getopts specified -n, but it's not handled by this case.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:

getopts specified -n, but it's not handled by this case.

Problematic code:

while getopts "vrn" n
do
  case "$n" in
    v) echo "Verbose" ;;
    r) echo "Recursive" ;;
    \?) usage;;
  esac
done

Correct code:

while getopts "vrn" n
do
  case "$n" in
    v) echo "Verbose" ;;
    r) echo "Recursive" ;;
    n) echo "Dry-run" ;;    # -n handled here
    \?) usage;;
  esac
done

Rationale:

You have a while getopts loop where the corresponding case statement fails to handle one of the flags.

Either add a case to handle the flag, or remove it from the getopts option string.

Exceptions:

ShellCheck may not correctly recognize less canonical uses of while getopts ..; do case ..;, such as when modifying the variable before using it:

while getopts "rf-:" OPT; do
  if [ "$OPT" = "-" ]; then   # long option: reformulate OPT and OPTARG
    OPT="${OPTARG%%=*}"       # extract long option name
    OPTARG="${OPTARG#$OPT}"   # extract long option argument (may be empty)
    OPTARG="${OPTARG#=}"      # if long option argument, remove assigning `=`
  fi

  case "$OPT" in
    r) ... ;;
    f) ... ;;
    my-long-option) ... ;;
  esac
done

In such cases you can do one of:

• Ignore the warning.
• Use the external tool getopt (no "s") which supports long options natively.
• Rewrite to not modify the variable first, in this case by instead doing it in a -) branch.

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.