1 SC2289

Vidar Holen edited this page 2021-06-05 19:05:23 -07:00

Table of Contents

• This is interpreted as a command name containing a linefeed. Double check syntax.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

This is interpreted as a command name containing a linefeed. Double check syntax.

(or tab)

Problematic code:

'''
This script greets the planet
'''
echo "Hello World"

Correct code:

# This script greets the planet
echo "Hello World"

Rationale:

ShellCheck found a command name containing an especially unusual character like a tab or linefeed. This is most likely due to a syntax issue.

In the example, this was due to a Python style documentation string, which a shell will merely interpreted as a multi-line command name sandwiched between two empty strings.

Exceptions:

If you have a command name that does contain a tab or linefeed you can ignore this message, but... wow.

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.