5 SC2028

Joachim Ansorg edited this page 2021-11-12 19:21:42 +01:00

Table of Contents

• echo won't expand escape sequences. Consider printf.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions

echo won't expand escape sequences. Consider printf.

Problematic code:

echo "Name:\t$value"

Correct code:

printf 'Name:\t%s\n' "$value"

Rationale:

Backslash escapes like \t and \n are not expanded by echo, and become literal backslash-t, backslash-n.

printf does expand these sequences, and should be used instead.

Other, non-portable methods include echo -e '\t' and echo $'\t'. ShellCheck will warn if this is used in a script with shebang #!/bin/sh.

If you actually wanted a literal backslash-t, use

echo "\\t"

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.