1 SC3033

Vidar Holen edited this page 2022-11-02 21:00:40 -07:00

Table of Contents

• In POSIX sh, naming functions outside [a-zA-Z_][a-zA-Z0-9_]* is undefined.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

In POSIX sh, naming functions outside [a-zA-Z_][a-zA-Z0-9_]* is undefined.

Problematic code:

#!/bin/sh
run-tests() {
  make test
}

Correct code:

#!/bin/sh
run_tests() {
  make test
}

Rationale:

Your script uses a shell feature not supported by the shebang. Either rewrite the script to be portable, or change the shebang to explicitly require a shell like Bash.

In this case, you can rename your functions to follow the same naming requirements as variables, as these are the only names guaranteed to be valid function names in POSIX.

Exceptions:

None

Related resources:

• Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc!

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.