4

SC2152

Vidar Holen edited this page 2018-11-24 22:54:53 -08:00

Table of Contents

• Can only return 0-255. Other data should be written to stdout.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

Can only return 0-255. Other data should be written to stdout.

Problematic code:

myfunc() {
  return "Hello $USER"
}

Correct code:

myfunc() {
  echo "Hello $USER"
  return 0
}

Rationale:

In many languages, return is used to return from the function with a final result.

In sh/bash, return can only be used to signal success or failure (0 = success, 1-255 = failure), more akin to throw/raise in other languages.

Results should instead be written to stdout and captured:

message=$(myfunc)
echo "The function wrote: $message"

In functions that return small integers, such as getting the cpu temperature, the value should still be written to stdout. return should be reserved for error conditions, such as "can't determine CPU temperature". Error or failure messages should be written to stderr.

Note in particular that return -1 is equivalent to return 255, but that return 1 is the more canonical way of expressing the first possible error code.

Exceptions:

None

Related resources:

• BashFaq: How do I return a string (or large number, or negative number) from a function? "return" only lets me give a number from 0 to 255.

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.