8 SC2033

Vidar Holen edited this page 2021-11-14 21:33:53 -08:00

Table of Contents

• Shell functions can't be passed to external commands. Use separate script or sh -c.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions

Shell functions can't be passed to external commands. Use separate script or sh -c.

Problematic code:

foo() { bar --baz "$@"; frob --baz "$@"; };
find . -exec foo {} +

Correct code:

find . -exec sh -c 'bar --baz "$@"; frob --baz "$@";' -- {} +

Rationale:

Shell functions are only known to the shell. External commands like find, xargs, su and sudo do not recognize shell functions.

Instead, the function contents can be executed in a shell, either through sh -c or by creating a separate shell script as an executable file.

Exceptions

If you're intentionally passing a word that happens to have the same name as a declared function, you can quote it to make shellcheck ignore it, e.g.

nobody() {
  sudo -u "nobody" "$@"
}

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.