9

SC2206

Ulrik Haugen edited this page 2024-04-25 18:25:44 +02:00

Table of Contents

• Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:

Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.

Problematic code:

array=( $var )

Correct code:

If the variable should be a single element:

array=( "$var" )

If it's multiple lines, each of which should be an element:

# For bash
mapfile -t array <<< "$var"

# For ksh
printf '%s\n' "$var" | while IFS="" read -r line; do array+=("$line"); done

If it's a line with multiple words (separated by spaces, other delimiters can be chosen with IFS), each of which should be an element:

# For bash
IFS=" " read -r -a array <<< "$var"

# For ksh
IFS=" " read -r -A array <<< "$var"

Rationale:

You are expanding a variable unquoted in an array. This will invoke the shell's sloppy word splitting and glob expansion.

Instead, prefer explicitly splitting (or not splitting):

• If the variable should become a single array element, quote it.
• If you want to split into lines or words, use mapfile, read -ra and/or while loops as appropriate.

This prevents the shell from doing unwanted splitting and glob expansion, and therefore avoiding problems with data containing spaces or special characters.

Exceptions:

If you have already taken care (through setting IFS and set -f) to have word splitting work the way you intend, you can ignore this warning.

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.