In sh/bash, return can only be used to signal success or failure (0 = success, 1-255 = failure), which is in a sense similar to throw/raise in other languages. Other results should instead be written to stdout and captured:

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

Even if a function is meant to return a number, (E.g. a function that returns the current CPU temperature) the value must be written to stdout instead of returned. return should be reserved for error conditions, such as when the function can't determine the 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 most common error code.

Bad Practice

myfunc() {
  return "Hello $USER"
}

Recommended:

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

References

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.

AnalogCyan / dotfiles

No ignore rules found