2 SC2215

Michael Sanders edited this page 2017-12-10 20:20:36 -08:00

Table of Contents

• This flag is used as a command name. Bad line break or missing [ .. ]?
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:

This flag is used as a command name. Bad line break or missing [ .. ]?

Problematic code:

if -e .bashrc
then
  echo ".bashrc already exists"
fi

or

find . -name '*.mkv'
       -exec mplayer {} \;

Correct code:

if [ -e .bashrc ]
then
  echo ".bashrc already exists"
fi

or

find . -name '*.mkv' \
       -exec mplayer {} \;

Rationale:

You are using a name that starts with a dash as a command name. This is almost always a bug.

There are two typical ways in which this happens:

• Missing [ .. ] or [[ .. ]] around a test expression, like in the first example example.
• An invalid line break that splits a command in two, like in the second example.

Exceptions:

If you actually have a command that starts with a dash -- which you should really reconsider -- you can quote the name (or at least the leading dash). This makes no difference to the shell, but makes it clear to ShellCheck and humans that this is not intended as a flag.

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.