6 SC2248

Vidar Holen edited this page 2022-07-20 12:06:09 -07:00

Table of Contents

• Prefer double quoting even when variables don't contain special characters.
• Problematic code:
• Correct code:
• Rationale:

Prefer double quoting even when variables don't contain special characters.

This is an optional suggestion. It must be explicitly enabled with a directive enable=quote-safe-variables in a # shellcheck comment or .shellcheckrc

Problematic code:

subdir='example'

cd ${subdir}

Correct code:

subdir='example'

cd "${subdir}"

Rationale:

Shellcheck normally warns about unquoted variable use due to potential globbing or word splitting issues. See SC2086 for details. However if it is determined that a variable does not have have spaces or special characters it will omit that warning. This optional warning exists to suggest that quotes be used even in this scenario. If the code is later changed such that special characters can appear in the variable, having its use already quoted will prevent issues.

This optional warning is also helpful if shellcheck's analysis of the variable contents is wrong because of indirect modification of the variable or because unknown commands implemented as shell functions have modified the variable.

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.