2 SC2231

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

Table of Contents

• Quote expansions in this for loop glob to prevent wordsplitting, e.g. "$dir"/*.txt .
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

Quote expansions in this for loop glob to prevent wordsplitting, e.g. "$dir"/*.txt .

Problematic code:

for file in $dir/*.txt
do
  echo "Found $file"
done

Correct code:

for file in "$dir"/*.txt
do
  echo "Found $file"
done

Rationale:

When iterating over globs containing expansions, you can still quote all expansions in the path to better handle whitespace and special characters.

Just make sure glob characters are outside quotes. "$dir/*.txt" will not glob expand, but "$dir"/*.txt or "$dir"/*."$ext" will.

Exceptions:

Exceptions similar to SC2086 apply. If the variable is expected to contain globs, such as if dir="tmp/**" in the example, you can ignore this message.

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.