3 SC3003

Eisuke Kawashima edited this page 2023-11-08 17:58:02 +09:00

Table of Contents

• In POSIX sh, $'..' is undefined.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

In POSIX sh, $'..' is undefined.

Problematic code:

#!/bin/sh
IFS=$' \t\n'

Correct code:

#!/bin/sh
# Note: \n can not be last, or it will be stripped by $()
IFS=$(printf ' \n\t')

or

#!/bin/sh
# Trailing linefeed added literally
IFS="$(printf ' \t')
"

or

#!/bin/bash
# Bash supports this
IFS=$' \t\n'

Rationale:

ANSI-C quoting, $'..', is a bash extension, which is not supported by POSIX sh.

To ensure the script runs correctly on other systems, either switch to Bash, or rewrite it in a POSIX compatible way.

This can generally done via printf as in the example. Be careful about strings with trailing linefeeds, as a $(command substitution) will strip them.

Exceptions:

None.

Related resources:

• StackOverflow: Why does my bash code fail when I run it with sh?

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.