5 SC2123

Joachim Ansorg edited this page 2021-11-12 19:37:00 +01:00

Table of Contents

• PATH is the shell search path. Use another name.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions

PATH is the shell search path. Use another name.

Problematic code:

PATH=/my/dir
cat "$PATH/myfile"

Correct code:

Good practice: always use lowercase for unexported variables.

path=/my/dir
cat "$path/myfile"

Bad practice: use another uppercase name.

MYPATH=/my/dir
cat "$MYPATH/myfile"

Rationale:

PATH is where the shell looks for the commands it executes. By inadvertently overwriting it, the shell will be unable to find commands (like cat in this case).

You get this warning when ShellCheck suspects that you didn't meant to overwrite it (because it's a single path with no path separators).

Best shell scripting practice is to always use lowercase variable names to avoid accidentally overwriting exported and internal variables.

Exceptions

If you're aware of the above and really do want to set your shell search path to /my/dir, you can ignore this warning.

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.